Stronger model typings

[github/Chocobozzz/PeerTube.git] / server / models / video / video-share.ts

diff --git a/server/models/video/video-share.ts b/server/models/video/video-share.ts
index 37e405fa9810dd519dbcd02ea5d1d31961cf9fc7..9019b401abeda0d0439cebb63673c91f7effd370 100644 (file)
--- a/server/models/video/video-share.ts
+++ b/server/models/video/video-share.ts
@@ -1,84 +1,221 @@
-import * as Sequelize from 'sequelize'
+import * as Bluebird from 'bluebird'
+import { AllowNull, BelongsTo, Column, CreatedAt, DataType, ForeignKey, Is, Model, Scopes, Table, UpdatedAt } from 'sequelize-typescript'
+import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
+import { CONSTRAINTS_FIELDS } from '../../initializers/constants'
+import { AccountModel } from '../account/account'
+import { ActorModel } from '../activitypub/actor'
+import { buildLocalActorIdsIn, throwIfNotValid } from '../utils'
+import { VideoModel } from './video'
+import { VideoChannelModel } from './video-channel'
+import { Op, Transaction } from 'sequelize'
+import { MVideoShareActor, MVideoShareFull } from '../../typings/models/video'
+import { MActorDefault } from '../../typings/models'
 
-import { addMethodsToModel } from '../utils'
-import { VideoShareAttributes, VideoShareInstance, VideoShareMethods } from './video-share-interface'
-
-let VideoShare: Sequelize.Model<VideoShareInstance, VideoShareAttributes>
-let loadAccountsByShare: VideoShareMethods.LoadAccountsByShare
-let load: VideoShareMethods.Load
+enum ScopeNames {
+  FULL = 'FULL',
+  WITH_ACTOR = 'WITH_ACTOR'
+}
 
-export default function (sequelize: Sequelize.Sequelize, DataTypes: Sequelize.DataTypes) {
-  VideoShare = sequelize.define<VideoShareInstance, VideoShareAttributes>('VideoShare',
-    { },
+@Scopes(() => ({
+  [ScopeNames.FULL]: {
+    include: [
+      {
+        model: ActorModel,
+        required: true
+      },
+      {
+        model: VideoModel,
+        required: true
+      }
+    ]
+  },
+  [ScopeNames.WITH_ACTOR]: {
+    include: [
+      {
+        model: ActorModel,
+        required: true
+      }
+    ]
+  }
+}))
+@Table({
+  tableName: 'videoShare',
+  indexes: [
     {
-      indexes: [
-        {
-          fields: [ 'accountId' ]
-        },
-        {
-          fields: [ 'videoId' ]
-        }
-      ]
+      fields: [ 'actorId' ]
+    },
+    {
+      fields: [ 'videoId' ]
+    },
+    {
+      fields: [ 'url' ],
+      unique: true
     }
-  )
-
-  const classMethods = [
-    associate,
-    loadAccountsByShare,
-    load
   ]
-  addMethodsToModel(VideoShare, classMethods)
+})
+export class VideoShareModel extends Model<VideoShareModel> {
 
-  return VideoShare
-}
+  @AllowNull(false)
+  @Is('VideoShareUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
+  @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_SHARE.URL.max))
+  url: string
 
-// ------------------------------ METHODS ------------------------------
+  @CreatedAt
+  createdAt: Date
 
-function associate (models) {
-  VideoShare.belongsTo(models.Account, {
+  @UpdatedAt
+  updatedAt: Date
+
+  @ForeignKey(() => ActorModel)
+  @Column
+  actorId: number
+
+  @BelongsTo(() => ActorModel, {
     foreignKey: {
-      name: 'accountId',
       allowNull: false
     },
     onDelete: 'cascade'
   })
+  Actor: ActorModel
 
-  VideoShare.belongsTo(models.Video, {
+  @ForeignKey(() => VideoModel)
+  @Column
+  videoId: number
+
+  @BelongsTo(() => VideoModel, {
     foreignKey: {
-      name: 'videoId',
-      allowNull: true
+      allowNull: false
     },
     onDelete: 'cascade'
   })
-}
+  Video: VideoModel
 
-load = function (accountId: number, videoId: number, t: Sequelize.Transaction) {
-  return VideoShare.findOne({
-    where: {
-      accountId,
-      videoId
-    },
-    include: [
-      VideoShare['sequelize'].models.Account
-    ],
-    transaction: t
-  })
-}
+  static load (actorId: number, videoId: number, t?: Transaction): Bluebird<MVideoShareActor> {
+    return VideoShareModel.scope(ScopeNames.WITH_ACTOR).findOne({
+      where: {
+        actorId,
+        videoId
+      },
+      transaction: t
+    })
+  }
 
-loadAccountsByShare = function (videoId: number, t: Sequelize.Transaction) {
-  const query = {
-    where: {
-      videoId
-    },
-    include: [
-      {
-        model: VideoShare['sequelize'].models.Account,
-        required: true
-      }
-    ],
-    transaction: t
+  static loadByUrl (url: string, t: Transaction): Bluebird<MVideoShareFull> {
+    return VideoShareModel.scope(ScopeNames.FULL).findOne({
+      where: {
+        url
+      },
+      transaction: t
+    })
+  }
+
+  static loadActorsByShare (videoId: number, t: Transaction): Bluebird<MActorDefault[]> {
+    const query = {
+      where: {
+        videoId
+      },
+      include: [
+        {
+          model: ActorModel,
+          required: true
+        }
+      ],
+      transaction: t
+    }
+
+    return VideoShareModel.scope(ScopeNames.FULL).findAll(query)
+      .then((res: MVideoShareFull[]) => res.map(r => r.Actor))
   }
 
-  return VideoShare.findAll(query)
-    .then(res => res.map(r => r.Account))
+  static loadActorsWhoSharedVideosOf (actorOwnerId: number, t: Transaction): Bluebird<MActorDefault[]> {
+    const query = {
+      attributes: [],
+      include: [
+        {
+          model: ActorModel,
+          required: true
+        },
+        {
+          attributes: [],
+          model: VideoModel,
+          required: true,
+          include: [
+            {
+              attributes: [],
+              model: VideoChannelModel.unscoped(),
+              required: true,
+              include: [
+                {
+                  attributes: [],
+                  model: AccountModel.unscoped(),
+                  required: true,
+                  where: {
+                    actorId: actorOwnerId
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ],
+      transaction: t
+    }
+
+    return VideoShareModel.scope(ScopeNames.FULL).findAll(query)
+      .then(res => res.map(r => r.Actor))
+  }
+
+  static loadActorsByVideoChannel (videoChannelId: number, t: Transaction): Bluebird<MActorDefault[]> {
+    const query = {
+      attributes: [],
+      include: [
+        {
+          model: ActorModel,
+          required: true
+        },
+        {
+          attributes: [],
+          model: VideoModel,
+          required: true,
+          where: {
+            channelId: videoChannelId
+          }
+        }
+      ],
+      transaction: t
+    }
+
+    return VideoShareModel.scope(ScopeNames.FULL)
+      .findAll(query)
+      .then(res => res.map(r => r.Actor))
+  }
+
+  static listAndCountByVideoId (videoId: number, start: number, count: number, t?: Transaction) {
+    const query = {
+      offset: start,
+      limit: count,
+      where: {
+        videoId
+      },
+      transaction: t
+    }
+
+    return VideoShareModel.findAndCountAll(query)
+  }
+
+  static cleanOldSharesOf (videoId: number, beforeUpdatedAt: Date) {
+    const query = {
+      where: {
+        updatedAt: {
+          [Op.lt]: beforeUpdatedAt
+        },
+        videoId,
+        actorId: {
+          [Op.notIn]: buildLocalActorIdsIn()
+        }
+      }
+    }
+
+    return VideoShareModel.destroy(query)
+  }
 }