]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/models/video/video-comment.ts
Add video comments RSS
[github/Chocobozzz/PeerTube.git] / server / models / video / video-comment.ts
index 8e84bfc06ab0603429b4811c8837a73c8f93136f..353fb1a0eb947cbee47b8ef28d9b88242c10f5d4 100644 (file)
@@ -1,23 +1,98 @@
 import * as Sequelize from 'sequelize'
 import {
-  AfterDestroy, AllowNull, BelongsTo, Column, CreatedAt, DataType, ForeignKey, IFindOptions, Is, Model, Scopes, Table,
+  AllowNull, BeforeDestroy, BelongsTo, Column, CreatedAt, DataType, ForeignKey, IFindOptions, Is, Model, Scopes, Table,
   UpdatedAt
 } from 'sequelize-typescript'
+import { ActivityTagObject } from '../../../shared/models/activitypub/objects/common-objects'
+import { VideoCommentObject } from '../../../shared/models/activitypub/objects/video-comment-object'
 import { VideoComment } from '../../../shared/models/videos/video-comment.model'
-import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub'
+import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
 import { CONSTRAINTS_FIELDS } from '../../initializers'
+import { sendDeleteVideoComment } from '../../lib/activitypub/send'
 import { AccountModel } from '../account/account'
+import { ActorModel } from '../activitypub/actor'
+import { AvatarModel } from '../avatar/avatar'
+import { ServerModel } from '../server/server'
 import { getSort, throwIfNotValid } from '../utils'
 import { VideoModel } from './video'
+import { VideoChannelModel } from './video-channel'
 
 enum ScopeNames {
-  WITH_ACCOUNT = 'WITH_ACCOUNT'
+  WITH_ACCOUNT = 'WITH_ACCOUNT',
+  WITH_IN_REPLY_TO = 'WITH_IN_REPLY_TO',
+  WITH_VIDEO = 'WITH_VIDEO',
+  ATTRIBUTES_FOR_API = 'ATTRIBUTES_FOR_API'
 }
 
 @Scopes({
+  [ScopeNames.ATTRIBUTES_FOR_API]: {
+    attributes: {
+      include: [
+        [
+          Sequelize.literal(
+            '(SELECT COUNT("replies"."id") ' +
+            'FROM "videoComment" AS "replies" ' +
+            'WHERE "replies"."originCommentId" = "VideoCommentModel"."id")'
+          ),
+          'totalReplies'
+        ]
+      ]
+    }
+  },
   [ScopeNames.WITH_ACCOUNT]: {
     include: [
-      () => AccountModel
+      {
+        model: () => AccountModel,
+        include: [
+          {
+            model: () => ActorModel,
+            include: [
+              {
+                model: () => ServerModel,
+                required: false
+              },
+              {
+                model: () => AvatarModel,
+                required: false
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  },
+  [ScopeNames.WITH_IN_REPLY_TO]: {
+    include: [
+      {
+        model: () => VideoCommentModel,
+        as: 'InReplyToVideoComment'
+      }
+    ]
+  },
+  [ScopeNames.WITH_VIDEO]: {
+    include: [
+      {
+        model: () => VideoModel,
+        required: true,
+        include: [
+          {
+            model: () => VideoChannelModel.unscoped(),
+            required: true,
+            include: [
+              {
+                model: () => AccountModel,
+                required: true,
+                include: [
+                  {
+                    model: () => ActorModel,
+                    required: true
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
     ]
   }
 })
@@ -29,6 +104,10 @@ enum ScopeNames {
     },
     {
       fields: [ 'videoId', 'originCommentId' ]
+    },
+    {
+      fields: [ 'url' ],
+      unique: true
     }
   ]
 })
@@ -54,8 +133,10 @@ export class VideoCommentModel extends Model<VideoCommentModel> {
 
   @BelongsTo(() => VideoCommentModel, {
     foreignKey: {
+      name: 'originCommentId',
       allowNull: true
     },
+    as: 'OriginVideoComment',
     onDelete: 'CASCADE'
   })
   OriginVideoComment: VideoCommentModel
@@ -66,8 +147,10 @@ export class VideoCommentModel extends Model<VideoCommentModel> {
 
   @BelongsTo(() => VideoCommentModel, {
     foreignKey: {
+      name: 'inReplyToCommentId',
       allowNull: true
     },
+    as: 'InReplyToVideoComment',
     onDelete: 'CASCADE'
   })
   InReplyToVideoComment: VideoCommentModel
@@ -96,10 +179,39 @@ export class VideoCommentModel extends Model<VideoCommentModel> {
   })
   Account: AccountModel
 
-  @AfterDestroy
-  static sendDeleteIfOwned (instance: VideoCommentModel) {
-    // TODO
-    return undefined
+  @BeforeDestroy
+  static async sendDeleteIfOwned (instance: VideoCommentModel, options) {
+    if (!instance.Account || !instance.Account.Actor) {
+      instance.Account = await instance.$get('Account', {
+        include: [ ActorModel ],
+        transaction: options.transaction
+      }) as AccountModel
+    }
+
+    if (!instance.Video) {
+      instance.Video = await instance.$get('Video', {
+        include: [
+          {
+            model: VideoChannelModel,
+            include: [
+              {
+                model: AccountModel,
+                include: [
+                  {
+                    model: ActorModel
+                  }
+                ]
+              }
+            ]
+          }
+        ],
+        transaction: options.transaction
+      }) as VideoModel
+    }
+
+    if (instance.isOwned()) {
+      await sendDeleteVideoComment(instance, options.transaction)
+    }
   }
 
   static loadById (id: number, t?: Sequelize.Transaction) {
@@ -114,7 +226,21 @@ export class VideoCommentModel extends Model<VideoCommentModel> {
     return VideoCommentModel.findOne(query)
   }
 
-  static loadByUrl (url: string, t?: Sequelize.Transaction) {
+  static loadByIdAndPopulateVideoAndAccountAndReply (id: number, t?: Sequelize.Transaction) {
+    const query: IFindOptions<VideoCommentModel> = {
+      where: {
+        id
+      }
+    }
+
+    if (t !== undefined) query.transaction = t
+
+    return VideoCommentModel
+      .scope([ ScopeNames.WITH_VIDEO, ScopeNames.WITH_ACCOUNT, ScopeNames.WITH_IN_REPLY_TO ])
+      .findOne(query)
+  }
+
+  static loadByUrlAndPopulateAccount (url: string, t?: Sequelize.Transaction) {
     const query: IFindOptions<VideoCommentModel> = {
       where: {
         url
@@ -123,14 +249,26 @@ export class VideoCommentModel extends Model<VideoCommentModel> {
 
     if (t !== undefined) query.transaction = t
 
-    return VideoCommentModel.findOne(query)
+    return VideoCommentModel.scope([ ScopeNames.WITH_ACCOUNT ]).findOne(query)
+  }
+
+  static loadByUrlAndPopulateReplyAndVideo (url: string, t?: Sequelize.Transaction) {
+    const query: IFindOptions<VideoCommentModel> = {
+      where: {
+        url
+      }
+    }
+
+    if (t !== undefined) query.transaction = t
+
+    return VideoCommentModel.scope([ ScopeNames.WITH_IN_REPLY_TO, ScopeNames.WITH_VIDEO ]).findOne(query)
   }
 
   static listThreadsForApi (videoId: number, start: number, count: number, sort: string) {
     const query = {
       offset: start,
       limit: count,
-      order: [ getSort(sort) ],
+      order: getSort(sort),
       where: {
         videoId,
         inReplyToCommentId: null
@@ -138,7 +276,7 @@ export class VideoCommentModel extends Model<VideoCommentModel> {
     }
 
     return VideoCommentModel
-      .scope([ ScopeNames.WITH_ACCOUNT ])
+      .scope([ ScopeNames.WITH_ACCOUNT, ScopeNames.ATTRIBUTES_FOR_API ])
       .findAndCountAll(query)
       .then(({ rows, count }) => {
         return { total: count, data: rows }
@@ -147,7 +285,7 @@ export class VideoCommentModel extends Model<VideoCommentModel> {
 
   static listThreadCommentsForApi (videoId: number, threadId: number) {
     const query = {
-      order: [ [ 'id', 'ASC' ] ],
+      order: [ [ 'createdAt', 'ASC' ], [ 'updatedAt', 'ASC' ] ],
       where: {
         videoId,
         [ Sequelize.Op.or ]: [
@@ -158,26 +296,151 @@ export class VideoCommentModel extends Model<VideoCommentModel> {
     }
 
     return VideoCommentModel
-      .scope([ ScopeNames.WITH_ACCOUNT ])
+      .scope([ ScopeNames.WITH_ACCOUNT, ScopeNames.ATTRIBUTES_FOR_API ])
       .findAndCountAll(query)
       .then(({ rows, count }) => {
         return { total: count, data: rows }
       })
   }
 
+  static listThreadParentComments (comment: VideoCommentModel, t: Sequelize.Transaction, order: 'ASC' | 'DESC' = 'ASC') {
+    const query = {
+      order: [ [ 'createdAt', order ] ],
+      where: {
+        id: {
+          [ Sequelize.Op.in ]: Sequelize.literal('(' +
+            'WITH RECURSIVE children (id, "inReplyToCommentId") AS ( ' +
+            'SELECT id, "inReplyToCommentId" FROM "videoComment" WHERE id = ' + comment.id + ' UNION ' +
+            'SELECT p.id, p."inReplyToCommentId" from "videoComment" p ' +
+            'INNER JOIN children c ON c."inReplyToCommentId" = p.id) ' +
+            'SELECT id FROM children' +
+          ')'),
+          [ Sequelize.Op.ne ]: comment.id
+        }
+      },
+      transaction: t
+    }
+
+    return VideoCommentModel
+      .scope([ ScopeNames.WITH_ACCOUNT ])
+      .findAll(query)
+  }
+
+  static listAndCountByVideoId (videoId: number, start: number, count: number, t?: Sequelize.Transaction, order: 'ASC' | 'DESC' = 'ASC') {
+    const query = {
+      order: [ [ 'createdAt', order ] ],
+      start,
+      count,
+      where: {
+        videoId
+      },
+      transaction: t
+    }
+
+    return VideoCommentModel.findAndCountAll(query)
+  }
+
+  static listForFeed (start: number, count: number, videoId?: number) {
+    const query = {
+      order: [ [ 'createdAt', 'DESC' ] ],
+      start,
+      count,
+      where: {},
+      include: [
+        {
+          attributes: [ 'name' ],
+          model: VideoModel.unscoped(),
+          required: true
+        }
+      ]
+    }
+
+    if (videoId) query.where['videoId'] = videoId
+
+    return VideoCommentModel
+      .scope([ ScopeNames.WITH_ACCOUNT ])
+      .findAll(query)
+  }
+
+  static async getStats () {
+    const totalLocalVideoComments = await VideoCommentModel.count({
+      include: [
+        {
+          model: AccountModel,
+          required: true,
+          include: [
+            {
+              model: ActorModel,
+              required: true,
+              where: {
+                serverId: null
+              }
+            }
+          ]
+        }
+      ]
+    })
+    const totalVideoComments = await VideoCommentModel.count()
+
+    return {
+      totalLocalVideoComments,
+      totalVideoComments
+    }
+  }
+
+  getThreadId (): number {
+    return this.originCommentId || this.id
+  }
+
+  isOwned () {
+    return this.Account.isOwned()
+  }
+
   toFormattedJSON () {
     return {
       id: this.id,
       url: this.url,
       text: this.text,
       threadId: this.originCommentId || this.id,
-      inReplyToCommentId: this.inReplyToCommentId,
+      inReplyToCommentId: this.inReplyToCommentId || null,
       videoId: this.videoId,
       createdAt: this.createdAt,
       updatedAt: this.updatedAt,
-      account: {
-        name: this.Account.name
-      }
+      totalReplies: this.get('totalReplies') || 0,
+      account: this.Account.toFormattedJSON()
     } as VideoComment
   }
+
+  toActivityPubObject (threadParentComments: VideoCommentModel[]): VideoCommentObject {
+    let inReplyTo: string
+    // New thread, so in AS we reply to the video
+    if (this.inReplyToCommentId === null) {
+      inReplyTo = this.Video.url
+    } else {
+      inReplyTo = this.InReplyToVideoComment.url
+    }
+
+    const tag: ActivityTagObject[] = []
+    for (const parentComment of threadParentComments) {
+      const actor = parentComment.Account.Actor
+
+      tag.push({
+        type: 'Mention',
+        href: actor.url,
+        name: `@${actor.preferredUsername}@${actor.getHost()}`
+      })
+    }
+
+    return {
+      type: 'Note' as 'Note',
+      id: this.url,
+      content: this.text,
+      inReplyTo,
+      updated: this.updatedAt.toISOString(),
+      published: this.createdAt.toISOString(),
+      url: this.url,
+      attributedTo: this.Account.Actor.url,
+      tag
+    }
+  }
 }