]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/models/video/video-channel.ts
Search video channel handle/uri
[github/Chocobozzz/PeerTube.git] / server / models / video / video-channel.ts
index e2cbf0422cd62bb2d721e8948d97df9b4c17962b..7d717fc68fd21f1b6bff6abbb8242cb0a5e05ebb 100644 (file)
@@ -1,32 +1,60 @@
 import {
-  AfterDestroy,
   AllowNull,
+  BeforeDestroy,
   BelongsTo,
   Column,
   CreatedAt,
+  DataType,
+  Default,
   DefaultScope,
   ForeignKey,
   HasMany,
   Is,
   Model,
   Scopes,
+  Sequelize,
   Table,
   UpdatedAt
 } from 'sequelize-typescript'
 import { ActivityPubActor } from '../../../shared/models/activitypub'
-import { isVideoChannelDescriptionValid, isVideoChannelNameValid } from '../../helpers/custom-validators/video-channels'
+import { VideoChannel } from '../../../shared/models/videos'
+import {
+  isVideoChannelDescriptionValid,
+  isVideoChannelNameValid,
+  isVideoChannelSupportValid
+} from '../../helpers/custom-validators/video-channels'
 import { sendDeleteActor } from '../../lib/activitypub/send'
 import { AccountModel } from '../account/account'
-import { ActorModel } from '../activitypub/actor'
-import { getSort, throwIfNotValid } from '../utils'
+import { ActorModel, unusedActorAttributesForAPI } from '../activitypub/actor'
+import { buildTrigramSearchIndex, createSimilarityAttribute, getSort, throwIfNotValid } from '../utils'
 import { VideoModel } from './video'
+import { CONSTRAINTS_FIELDS } from '../../initializers'
+import { ServerModel } from '../server/server'
+import { DefineIndexesOptions } from 'sequelize'
+
+// FIXME: Define indexes here because there is an issue with TS and Sequelize.literal when called directly in the annotation
+const indexes: DefineIndexesOptions[] = [
+  buildTrigramSearchIndex('video_channel_name_trigram', 'name'),
+
+  {
+    fields: [ 'accountId' ]
+  },
+  {
+    fields: [ 'actorId' ]
+  }
+]
 
 enum ScopeNames {
+  AVAILABLE_FOR_LIST = 'AVAILABLE_FOR_LIST',
   WITH_ACCOUNT = 'WITH_ACCOUNT',
   WITH_ACTOR = 'WITH_ACTOR',
   WITH_VIDEOS = 'WITH_VIDEOS'
 }
 
+type AvailableForListOptions = {
+  actorId: number
+}
+
 @DefaultScope({
   include: [
     {
@@ -36,17 +64,57 @@ enum ScopeNames {
   ]
 })
 @Scopes({
+  [ScopeNames.AVAILABLE_FOR_LIST]: (options: AvailableForListOptions) => {
+    const actorIdNumber = parseInt(options.actorId + '', 10)
+
+    // Only list local channels OR channels that are on an instance followed by actorId
+    const inQueryInstanceFollow = '(' +
+      'SELECT "actor"."serverId" FROM "actor" ' +
+      'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = actor.id ' +
+      'WHERE "actorFollow"."actorId" = ' + actorIdNumber +
+    ')'
+
+    return {
+      include: [
+        {
+          attributes: {
+            exclude: unusedActorAttributesForAPI
+          },
+          model: ActorModel,
+          where: {
+            [Sequelize.Op.or]: [
+              {
+                serverId: null
+              },
+              {
+                serverId: {
+                  [ Sequelize.Op.in ]: Sequelize.literal(inQueryInstanceFollow)
+                }
+              }
+            ]
+          }
+        },
+        {
+          model: AccountModel,
+          required: true,
+          include: [
+            {
+              attributes: {
+                exclude: unusedActorAttributesForAPI
+              },
+              model: ActorModel, // Default scope includes avatar and server
+              required: true
+            }
+          ]
+        }
+      ]
+    }
+  },
   [ScopeNames.WITH_ACCOUNT]: {
     include: [
       {
         model: () => AccountModel,
-        required: true,
-        include: [
-          {
-            model: () => ActorModel,
-            required: true
-          }
-        ]
+        required: true
       }
     ]
   },
@@ -63,11 +131,7 @@ enum ScopeNames {
 })
 @Table({
   tableName: 'videoChannel',
-  indexes: [
-    {
-      fields: [ 'accountId' ]
-    }
-  ]
+  indexes
 })
 export class VideoChannelModel extends Model<VideoChannelModel> {
 
@@ -77,10 +141,17 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
   name: string
 
   @AllowNull(true)
+  @Default(null)
   @Is('VideoChannelDescription', value => throwIfNotValid(value, isVideoChannelDescriptionValid, 'description'))
-  @Column
+  @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_CHANNELS.DESCRIPTION.max))
   description: string
 
+  @AllowNull(true)
+  @Default(null)
+  @Is('VideoChannelSupport', value => throwIfNotValid(value, isVideoChannelSupportValid, 'support'))
+  @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_CHANNELS.SUPPORT.max))
+  support: string
+
   @CreatedAt
   createdAt: Date
 
@@ -107,7 +178,7 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
     foreignKey: {
       allowNull: false
     },
-    onDelete: 'CASCADE'
+    hooks: true
   })
   Account: AccountModel
 
@@ -116,14 +187,19 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
       name: 'channelId',
       allowNull: false
     },
-    onDelete: 'CASCADE'
+    onDelete: 'CASCADE',
+    hooks: true
   })
   Videos: VideoModel[]
 
-  @AfterDestroy
-  static sendDeleteIfOwned (instance: VideoChannelModel) {
+  @BeforeDestroy
+  static async sendDeleteIfOwned (instance: VideoChannelModel, options) {
+    if (!instance.Actor) {
+      instance.Actor = await instance.$get('Actor', { transaction: options.transaction }) as ActorModel
+    }
+
     if (instance.Actor.isOwned()) {
-      return sendDeleteActor(instance.Actor, undefined)
+      return sendDeleteActor(instance.Actor, options.transaction)
     }
 
     return undefined
@@ -139,15 +215,61 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
     return VideoChannelModel.count(query)
   }
 
-  static listForApi (start: number, count: number, sort: string) {
+  static listForApi (actorId: number, start: number, count: number, sort: string) {
     const query = {
       offset: start,
       limit: count,
-      order: [ getSort(sort) ]
+      order: getSort(sort)
     }
 
+    const scopes = {
+      method: [ ScopeNames.AVAILABLE_FOR_LIST, { actorId } as AvailableForListOptions ]
+    }
     return VideoChannelModel
-      .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+      .scope(scopes)
+      .findAndCountAll(query)
+      .then(({ rows, count }) => {
+        return { total: count, data: rows }
+      })
+  }
+
+  static searchForApi (options: {
+    actorId: number
+    search: string
+    start: number
+    count: number
+    sort: string
+  }) {
+    const attributesInclude = []
+    const escapedSearch = VideoModel.sequelize.escape(options.search)
+    const escapedLikeSearch = VideoModel.sequelize.escape('%' + options.search + '%')
+    attributesInclude.push(createSimilarityAttribute('VideoChannelModel.name', options.search))
+
+    const query = {
+      attributes: {
+        include: attributesInclude
+      },
+      offset: options.start,
+      limit: options.count,
+      order: getSort(options.sort),
+      where: {
+        id: {
+          [ Sequelize.Op.in ]: Sequelize.literal(
+            '(' +
+              'SELECT id FROM "videoChannel" WHERE ' +
+              'lower(immutable_unaccent("name")) % lower(immutable_unaccent(' + escapedSearch + ')) OR ' +
+              'lower(immutable_unaccent("name")) LIKE lower(immutable_unaccent(' + escapedLikeSearch + '))' +
+            ')'
+          )
+        }
+      }
+    }
+
+    const scopes = {
+      method: [ ScopeNames.AVAILABLE_FOR_LIST, { actorId: options.actorId } as AvailableForListOptions ]
+    }
+    return VideoChannelModel
+      .scope(scopes)
       .findAndCountAll(query)
       .then(({ rows, count }) => {
         return { total: count, data: rows }
@@ -156,7 +278,7 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
 
   static listByAccount (accountId: number) {
     const query = {
-      order: [ getSort('createdAt') ],
+      order: getSort('createdAt'),
       include: [
         {
           model: AccountModel,
@@ -176,7 +298,7 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
   }
 
   static loadByIdAndAccount (id: number, accountId: number) {
-    const options = {
+    const query = {
       where: {
         id,
         accountId
@@ -185,7 +307,7 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
 
     return VideoChannelModel
       .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
-      .findOne(options)
+      .findOne(query)
   }
 
   static loadAndPopulateAccount (id: number) {
@@ -195,7 +317,7 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
   }
 
   static loadByUUIDAndPopulateAccount (uuid: string) {
-    const options = {
+    const query = {
       include: [
         {
           model: ActorModel,
@@ -207,9 +329,71 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
       ]
     }
 
+    return VideoChannelModel
+      .scope([ ScopeNames.WITH_ACCOUNT ])
+      .findOne(query)
+  }
+
+  static loadByUrlAndPopulateAccount (url: string) {
+    const query = {
+      include: [
+        {
+          model: ActorModel,
+          required: true,
+          where: {
+            url
+          }
+        }
+      ]
+    }
+
+    return VideoChannelModel
+      .scope([ ScopeNames.WITH_ACCOUNT ])
+      .findOne(query)
+  }
+
+  static loadLocalByNameAndPopulateAccount (name: string) {
+    const query = {
+      include: [
+        {
+          model: ActorModel,
+          required: true,
+          where: {
+            preferredUsername: name,
+            serverId: null
+          }
+        }
+      ]
+    }
+
+    return VideoChannelModel
+      .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
+      .findOne(query)
+  }
+
+  static loadByNameAndHostAndPopulateAccount (name: string, host: string) {
+    const query = {
+      include: [
+        {
+          model: ActorModel,
+          required: true,
+          where: {
+            preferredUsername: name
+          },
+          include: [
+            {
+              model: ServerModel,
+              required: true,
+              where: { host }
+            }
+          ]
+        }
+      ]
+    }
+
     return VideoChannelModel
       .scope([ ScopeNames.WITH_ACTOR, ScopeNames.WITH_ACCOUNT ])
-      .findOne(options)
+      .findOne(query)
   }
 
   static loadAndPopulateAccountAndVideos (id: number) {
@@ -224,18 +408,22 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
       .findById(id, options)
   }
 
-  toFormattedJSON () {
+  toFormattedJSON (): VideoChannel {
     const actor = this.Actor.toFormattedJSON()
-    const account = {
+    const videoChannel = {
       id: this.id,
-      displayName: this.name,
+      displayName: this.getDisplayName(),
       description: this.description,
+      support: this.support,
       isLocal: this.Actor.isOwned(),
       createdAt: this.createdAt,
-      updatedAt: this.updatedAt
+      updatedAt: this.updatedAt,
+      ownerAccount: undefined
     }
 
-    return Object.assign(actor, account)
+    if (this.Account) videoChannel.ownerAccount = this.Account.toFormattedJSON()
+
+    return Object.assign(actor, videoChannel)
   }
 
   toActivityPubObject (): ActivityPubActor {
@@ -243,6 +431,7 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
 
     return Object.assign(obj, {
       summary: this.description,
+      support: this.support,
       attributedTo: [
         {
           type: 'Person' as 'Person',
@@ -251,4 +440,8 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
       ]
     })
   }
+
+  getDisplayName () {
+    return this.name
+  }
 }