Search video channel handle/uri

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

diff --git a/server/models/video/video-channel.ts b/server/models/video/video-channel.ts
index d0dba18d5ac16c034b500d96c1a265286b2c0867..7d717fc68fd21f1b6bff6abbb8242cb0a5e05ebb 100644 (file)
--- a/server/models/video/video-channel.ts
+++ b/server/models/video/video-channel.ts
@@ -1,28 +1,60 @@
 import {
-  AllowNull, BeforeDestroy, BelongsTo, Column, CreatedAt, DefaultScope, ForeignKey, HasMany, Is, Model, Scopes, Table,
-  UpdatedAt, Default, DataType
+  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 { VideoChannel } from '../../../shared/models/videos'
 import {
-  isVideoChannelDescriptionValid, isVideoChannelNameValid,
+  isVideoChannelDescriptionValid,
+  isVideoChannelNameValid,
   isVideoChannelSupportValid
 } from '../../helpers/custom-validators/video-channels'
-import { logger } from '../../helpers/logger'
 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 { AvatarModel } from '../avatar/avatar'
+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: [
     {
@@ -32,23 +64,57 @@ enum ScopeNames {
   ]
 })
 @Scopes({
-  [ScopeNames.WITH_ACCOUNT]: {
-    include: [
-      {
-        model: () => AccountModel.unscoped(),
-        required: true,
-        include: [
-          {
-            model: () => ActorModel.unscoped(),
-            required: true,
-            include: [
+  [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
+              },
               {
-                model: () => AvatarModel.unscoped(),
-                required: false
+                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
       }
     ]
   },
@@ -65,14 +131,7 @@ enum ScopeNames {
 })
 @Table({
   tableName: 'videoChannel',
-  indexes: [
-    {
-      fields: [ 'accountId' ]
-    },
-    {
-      fields: [ 'actorId' ]
-    }
-  ]
+  indexes
 })
 export class VideoChannelModel extends Model<VideoChannelModel> {
 
@@ -156,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)
     }
 
+    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 }
@@ -193,7 +298,7 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
   }
 
   static loadByIdAndAccount (id: number, accountId: number) {
-    const options = {
+    const query = {
       where: {
         id,
         accountId
@@ -202,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) {
@@ -212,7 +317,7 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
   }
 
   static loadByUUIDAndPopulateAccount (uuid: string) {
-    const options = {
+    const query = {
       include: [
         {
           model: ActorModel,
@@ -224,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) {
@@ -251,8 +418,7 @@ export class VideoChannelModel extends Model<VideoChannelModel> {
       isLocal: this.Actor.isOwned(),
       createdAt: this.createdAt,
       updatedAt: this.updatedAt,
-      ownerAccount: undefined,
-      videos: undefined
+      ownerAccount: undefined
     }
 
     if (this.Account) videoChannel.ownerAccount = this.Account.toFormattedJSON()