]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blobdiff - server/models/video/video-query-builder.ts
Use raw sql for abuses
[github/Chocobozzz/PeerTube.git] / server / models / video / video-query-builder.ts
index c4b31e58e28dc67b5aba3b63978ea9bfc9b2ec8e..466890364522889f5c9074f18961b0fedb5f6eb0 100644 (file)
@@ -1,8 +1,9 @@
 import { VideoFilter, VideoPrivacy, VideoState } from '@shared/models'
 import { buildDirectionAndField, createSafeIn } from '@server/models/utils'
 import { Model } from 'sequelize-typescript'
-import { MUserAccountId, MUserId } from '@server/typings/models'
+import { MUserAccountId, MUserId } from '@server/types/models'
 import validator from 'validator'
+import { exists } from '@server/helpers/custom-validators/misc'
 
 export type BuildVideosQueryOptions = {
   attributes?: string[]
@@ -52,9 +53,9 @@ export type BuildVideosQueryOptions = {
 
 function buildListQuery (model: typeof Model, options: BuildVideosQueryOptions) {
   const and: string[] = []
-  const cte: string[] = []
   const joins: string[] = []
   const replacements: any = {}
+  const cte: string[] = []
 
   let attributes: string[] = options.attributes || [ '"video"."id"' ]
   let group = options.group || ''
@@ -63,7 +64,7 @@ function buildListQuery (model: typeof Model, options: BuildVideosQueryOptions)
   joins.push(
     'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId"' +
     'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId"' +
-    'INNER JOIN "actor" ON "account"."actorId" = "actor"."id"'
+    'INNER JOIN "actor" "accountActor" ON "account"."actorId" = "accountActor"."id"'
   )
 
   and.push('"video"."id" NOT IN (SELECT "videoBlacklist"."videoId" FROM "videoBlacklist")')
@@ -72,33 +73,19 @@ function buildListQuery (model: typeof Model, options: BuildVideosQueryOptions)
     const blockerIds = [ options.serverAccountId ]
     if (options.user) blockerIds.push(options.user.Account.id)
 
-    cte.push(
-      '"mutedAccount" AS (' +
-      '    SELECT "targetAccountId" AS "id"' +
-      '    FROM "accountBlocklist"' +
-      '    WHERE "accountId" IN (' + createSafeIn(model, blockerIds) + ')' +
-      '    UNION ALL' +
-      '    SELECT "account"."id" AS "id"' +
-      '    FROM account' +
-      '             INNER JOIN "actor" ON account."actorId" = actor.id' +
-      '             INNER JOIN "serverBlocklist" ON "actor"."serverId" = "serverBlocklist"."targetServerId"' +
-      '    WHERE "serverBlocklist"."accountId" IN (' + createSafeIn(model, blockerIds) + ')' +
-      ')'
-    )
-
-    cte.push(
-      '"mutedChannel" AS (' +
-      '        SELECT "videoChannel"."id"' +
-      '      FROM "videoChannel"' +
-      '      INNER JOIN "mutedAccount" ON "mutedAccount"."id" = "videoChannel"."accountId"' +
-      '    )'
-    )
+    const inClause = createSafeIn(model, blockerIds)
 
     and.push(
-      '"video"."channelId" NOT IN (SELECT "id" FROM "mutedChannel")'
+      'NOT EXISTS (' +
+      '  SELECT 1 FROM "accountBlocklist" ' +
+      '  WHERE "accountBlocklist"."accountId" IN (' + inClause + ') ' +
+      '  AND "accountBlocklist"."targetAccountId" = "account"."id" ' +
+      ')' +
+      'AND NOT EXISTS (' +
+      '  SELECT 1 FROM "serverBlocklist" WHERE "serverBlocklist"."accountId" IN (' + inClause + ') ' +
+      '  AND "serverBlocklist"."targetServerId" = "accountActor"."serverId"' +
+      ')'
     )
-
-    replacements.videoChannelId = options.videoChannelId
   }
 
   // Only list public/published videos
@@ -148,12 +135,14 @@ function buildListQuery (model: typeof Model, options: BuildVideosQueryOptions)
       '  EXISTS (' +
       '    SELECT 1 FROM "videoShare" ' +
       '    INNER JOIN "actorFollow" "actorFollowShare" ON "actorFollowShare"."targetActorId" = "videoShare"."actorId" ' +
-      '    AND "actorFollowShare"."actorId" = :followerActorId WHERE "videoShare"."videoId" = "video"."id"' +
+      '    AND "actorFollowShare"."actorId" = :followerActorId AND "actorFollowShare"."state" = \'accepted\' ' +
+      '    WHERE "videoShare"."videoId" = "video"."id"' +
       '  )' +
       '  OR' +
       '  EXISTS (' +
       '    SELECT 1 from "actorFollow" ' +
-      '    WHERE "actorFollow"."targetActorId" = "actor"."id" AND "actorFollow"."actorId" = :followerActorId' +
+      '    WHERE "actorFollow"."targetActorId" = "videoChannel"."actorId" AND "actorFollow"."actorId" = :followerActorId ' +
+      '    AND "actorFollow"."state" = \'accepted\'' +
       '  )'
 
     if (options.includeLocalVideos) {
@@ -216,23 +205,29 @@ function buildListQuery (model: typeof Model, options: BuildVideosQueryOptions)
   }
 
   if (options.languageOneOf) {
-    replacements.languageOneOf = options.languageOneOf.filter(l => l && l !== '_unknown')
-
-    let languagesQuery = '("video"."language" IN (:languageOneOf) OR '
+    const languages = options.languageOneOf.filter(l => l && l !== '_unknown')
+    const languagesQueryParts: string[] = []
+
+    if (languages.length !== 0) {
+      languagesQueryParts.push('"video"."language" IN (:languageOneOf)')
+      replacements.languageOneOf = languages
+
+      languagesQueryParts.push(
+        'EXISTS (' +
+        '  SELECT 1 FROM "videoCaption" WHERE "videoCaption"."language" ' +
+        '  IN (' + createSafeIn(model, languages) + ') AND ' +
+        '  "videoCaption"."videoId" = "video"."id"' +
+        ')'
+      )
+    }
 
     if (options.languageOneOf.includes('_unknown')) {
-      languagesQuery += '"video"."language" IS NULL OR '
+      languagesQueryParts.push('"video"."language" IS NULL')
     }
 
-    and.push(
-      languagesQuery +
-      '  EXISTS (' +
-      '    SELECT 1 FROM "videoCaption" WHERE "videoCaption"."language" ' +
-      '    IN (' + createSafeIn(model, options.languageOneOf) + ') AND ' +
-      '    "videoCaption"."videoId" = "video"."id"' +
-      '  )' +
-      ')'
-    )
+    if (languagesQueryParts.length !== 0) {
+      and.push('(' + languagesQueryParts.join(' OR ') + ')')
+    }
   }
 
   // We don't exclude results in this if so if we do a count we don't need to add this complex clauses
@@ -242,6 +237,8 @@ function buildListQuery (model: typeof Model, options: BuildVideosQueryOptions)
     joins.push('LEFT JOIN "videoView" ON "video"."id" = "videoView"."videoId" AND "videoView"."startDate" >= :viewsGteDate')
     replacements.viewsGteDate = viewsGteDate
 
+    attributes.push('COALESCE(SUM("videoView"."views"), 0) AS "videoViewsSum"')
+
     group = 'GROUP BY "video"."id"'
   }
 
@@ -249,7 +246,7 @@ function buildListQuery (model: typeof Model, options: BuildVideosQueryOptions)
     joins.push('INNER JOIN "userVideoHistory" on "video"."id" = "userVideoHistory"."videoId"')
 
     and.push('"userVideoHistory"."userId" = :historyOfUser')
-    replacements.historyOfUser = options.historyOfUser
+    replacements.historyOfUser = options.historyOfUser.id
   }
 
   if (options.startDate) {
@@ -286,9 +283,20 @@ function buildListQuery (model: typeof Model, options: BuildVideosQueryOptions)
     const escapedSearch = model.sequelize.escape(options.search)
     const escapedLikeSearch = model.sequelize.escape('%' + options.search + '%')
 
+    cte.push(
+      '"trigramSearch" AS (' +
+      '  SELECT "video"."id", ' +
+      `  similarity(lower(immutable_unaccent("video"."name")), lower(immutable_unaccent(${escapedSearch}))) as similarity ` +
+      '  FROM "video" ' +
+      '  WHERE lower(immutable_unaccent("video"."name")) % lower(immutable_unaccent(' + escapedSearch + ')) OR ' +
+      '        lower(immutable_unaccent("video"."name")) LIKE lower(immutable_unaccent(' + escapedLikeSearch + '))' +
+      ')'
+    )
+
+    joins.push('LEFT JOIN "trigramSearch" ON "video"."id" = "trigramSearch"."id"')
+
     let base = '(' +
-    '  lower(immutable_unaccent("video"."name")) % lower(immutable_unaccent(' + escapedSearch + ')) OR ' +
-    '  lower(immutable_unaccent("video"."name")) LIKE lower(immutable_unaccent(' + escapedLikeSearch + ')) OR ' +
+    '  "trigramSearch"."id" IS NOT NULL OR ' +
     '  EXISTS (' +
     '    SELECT 1 FROM "videoTag" ' +
     '    INNER JOIN "tag" ON "tag"."id" = "videoTag"."tagId" ' +
@@ -303,50 +311,70 @@ function buildListQuery (model: typeof Model, options: BuildVideosQueryOptions)
     base += ')'
     and.push(base)
 
-    attributes.push(`similarity(lower(immutable_unaccent("video"."name")), lower(immutable_unaccent(${escapedSearch}))) as similarity`)
+    attributes.push(`COALESCE("trigramSearch"."similarity", 0) as similarity`)
   } else {
     attributes.push('0 as similarity')
   }
 
   if (options.isCount === true) attributes = [ 'COUNT(*) as "total"' ]
 
+  let suffix = ''
+  let order = ''
+  if (options.isCount !== true) {
+
+    if (exists(options.sort)) {
+      if (options.sort === '-originallyPublishedAt' || options.sort === 'originallyPublishedAt') {
+        attributes.push('COALESCE("video"."originallyPublishedAt", "video"."publishedAt") AS "publishedAtForOrder"')
+      }
+
+      order = buildOrder(options.sort)
+      suffix += `${order} `
+    }
+
+    if (exists(options.count)) {
+      const count = parseInt(options.count + '', 10)
+      suffix += `LIMIT ${count} `
+    }
+
+    if (exists(options.start)) {
+      const start = parseInt(options.start + '', 10)
+      suffix += `OFFSET ${start} `
+    }
+  }
+
   const cteString = cte.length !== 0
-    ? 'WITH ' + cte.join(', ') + ' '
+    ? `WITH ${cte.join(', ')} `
     : ''
 
-  let query = cteString +
+  const query = cteString +
     'SELECT ' + attributes.join(', ') + ' ' +
     'FROM "video" ' + joins.join(' ') + ' ' +
     'WHERE ' + and.join(' AND ') + ' ' +
     group + ' ' +
-    having + ' '
+    having + ' ' +
+    suffix
 
-  if (options.isCount !== true) {
-    const count = parseInt(options.count + '', 10)
-    const start = parseInt(options.start + '', 10)
-
-    query += buildOrder(model, options.sort) + ' ' +
-      'LIMIT ' + count + ' ' +
-      'OFFSET ' + start
-  }
-
-  return { query, replacements }
+  return { query, replacements, order }
 }
 
-function buildOrder (model: typeof Model, value: string) {
+function buildOrder (value: string) {
   const { direction, field } = buildDirectionAndField(value)
-  if (field.match(/^[a-zA-Z]+$/) === null) throw new Error('Invalid sort column ' + field)
+  if (field.match(/^[a-zA-Z."]+$/) === null) throw new Error('Invalid sort column ' + field)
 
   if (field.toLowerCase() === 'random') return 'ORDER BY RANDOM()'
 
   if (field.toLowerCase() === 'trending') { // Sort by aggregation
-    return `ORDER BY COALESCE(SUM("videoView"."views"), 0) ${direction}, "video"."views" ${direction}`
+    return `ORDER BY "videoViewsSum" ${direction}, "video"."views" ${direction}`
   }
 
   let firstSort: string
 
   if (field.toLowerCase() === 'match') { // Search
     firstSort = '"similarity"'
+  } else if (field === 'originallyPublishedAt') {
+    firstSort = '"publishedAtForOrder"'
+  } else if (field.includes('.')) {
+    firstSort = field
   } else {
     firstSort = `"video"."${field}"`
   }
@@ -354,6 +382,124 @@ function buildOrder (model: typeof Model, value: string) {
   return `ORDER BY ${firstSort} ${direction}, "video"."id" ASC`
 }
 
+function wrapForAPIResults (baseQuery: string, replacements: any, options: BuildVideosQueryOptions, order: string) {
+  const attributes = {
+    '"video".*': '',
+    '"VideoChannel"."id"': '"VideoChannel.id"',
+    '"VideoChannel"."name"': '"VideoChannel.name"',
+    '"VideoChannel"."description"': '"VideoChannel.description"',
+    '"VideoChannel"."actorId"': '"VideoChannel.actorId"',
+    '"VideoChannel->Actor"."id"': '"VideoChannel.Actor.id"',
+    '"VideoChannel->Actor"."preferredUsername"': '"VideoChannel.Actor.preferredUsername"',
+    '"VideoChannel->Actor"."url"': '"VideoChannel.Actor.url"',
+    '"VideoChannel->Actor"."serverId"': '"VideoChannel.Actor.serverId"',
+    '"VideoChannel->Actor"."avatarId"': '"VideoChannel.Actor.avatarId"',
+    '"VideoChannel->Account"."id"': '"VideoChannel.Account.id"',
+    '"VideoChannel->Account"."name"': '"VideoChannel.Account.name"',
+    '"VideoChannel->Account->Actor"."id"': '"VideoChannel.Account.Actor.id"',
+    '"VideoChannel->Account->Actor"."preferredUsername"': '"VideoChannel.Account.Actor.preferredUsername"',
+    '"VideoChannel->Account->Actor"."url"': '"VideoChannel.Account.Actor.url"',
+    '"VideoChannel->Account->Actor"."serverId"': '"VideoChannel.Account.Actor.serverId"',
+    '"VideoChannel->Account->Actor"."avatarId"': '"VideoChannel.Account.Actor.avatarId"',
+    '"VideoChannel->Actor->Server"."id"': '"VideoChannel.Actor.Server.id"',
+    '"VideoChannel->Actor->Server"."host"': '"VideoChannel.Actor.Server.host"',
+    '"VideoChannel->Actor->Avatar"."id"': '"VideoChannel.Actor.Avatar.id"',
+    '"VideoChannel->Actor->Avatar"."filename"': '"VideoChannel.Actor.Avatar.filename"',
+    '"VideoChannel->Actor->Avatar"."fileUrl"': '"VideoChannel.Actor.Avatar.fileUrl"',
+    '"VideoChannel->Actor->Avatar"."onDisk"': '"VideoChannel.Actor.Avatar.onDisk"',
+    '"VideoChannel->Actor->Avatar"."createdAt"': '"VideoChannel.Actor.Avatar.createdAt"',
+    '"VideoChannel->Actor->Avatar"."updatedAt"': '"VideoChannel.Actor.Avatar.updatedAt"',
+    '"VideoChannel->Account->Actor->Server"."id"': '"VideoChannel.Account.Actor.Server.id"',
+    '"VideoChannel->Account->Actor->Server"."host"': '"VideoChannel.Account.Actor.Server.host"',
+    '"VideoChannel->Account->Actor->Avatar"."id"': '"VideoChannel.Account.Actor.Avatar.id"',
+    '"VideoChannel->Account->Actor->Avatar"."filename"': '"VideoChannel.Account.Actor.Avatar.filename"',
+    '"VideoChannel->Account->Actor->Avatar"."fileUrl"': '"VideoChannel.Account.Actor.Avatar.fileUrl"',
+    '"VideoChannel->Account->Actor->Avatar"."onDisk"': '"VideoChannel.Account.Actor.Avatar.onDisk"',
+    '"VideoChannel->Account->Actor->Avatar"."createdAt"': '"VideoChannel.Account.Actor.Avatar.createdAt"',
+    '"VideoChannel->Account->Actor->Avatar"."updatedAt"': '"VideoChannel.Account.Actor.Avatar.updatedAt"',
+    '"Thumbnails"."id"': '"Thumbnails.id"',
+    '"Thumbnails"."type"': '"Thumbnails.type"',
+    '"Thumbnails"."filename"': '"Thumbnails.filename"'
+  }
+
+  const joins = [
+    'INNER JOIN "video" ON "tmp"."id" = "video"."id"',
+
+    'INNER JOIN "videoChannel" AS "VideoChannel" ON "video"."channelId" = "VideoChannel"."id"',
+    'INNER JOIN "actor" AS "VideoChannel->Actor" ON "VideoChannel"."actorId" = "VideoChannel->Actor"."id"',
+    'INNER JOIN "account" AS "VideoChannel->Account" ON "VideoChannel"."accountId" = "VideoChannel->Account"."id"',
+    'INNER JOIN "actor" AS "VideoChannel->Account->Actor" ON "VideoChannel->Account"."actorId" = "VideoChannel->Account->Actor"."id"',
+
+    'LEFT OUTER JOIN "server" AS "VideoChannel->Actor->Server" ON "VideoChannel->Actor"."serverId" = "VideoChannel->Actor->Server"."id"',
+    'LEFT OUTER JOIN "avatar" AS "VideoChannel->Actor->Avatar" ON "VideoChannel->Actor"."avatarId" = "VideoChannel->Actor->Avatar"."id"',
+
+    'LEFT OUTER JOIN "server" AS "VideoChannel->Account->Actor->Server" ' +
+      'ON "VideoChannel->Account->Actor"."serverId" = "VideoChannel->Account->Actor->Server"."id"',
+
+    'LEFT OUTER JOIN "avatar" AS "VideoChannel->Account->Actor->Avatar" ' +
+      'ON "VideoChannel->Account->Actor"."avatarId" = "VideoChannel->Account->Actor->Avatar"."id"',
+
+    'LEFT OUTER JOIN "thumbnail" AS "Thumbnails" ON "video"."id" = "Thumbnails"."videoId"'
+  ]
+
+  if (options.withFiles) {
+    joins.push('INNER JOIN "videoFile" AS "VideoFiles" ON "VideoFiles"."videoId" = "video"."id"')
+
+    Object.assign(attributes, {
+      '"VideoFiles"."id"': '"VideoFiles.id"',
+      '"VideoFiles"."createdAt"': '"VideoFiles.createdAt"',
+      '"VideoFiles"."updatedAt"': '"VideoFiles.updatedAt"',
+      '"VideoFiles"."resolution"': '"VideoFiles.resolution"',
+      '"VideoFiles"."size"': '"VideoFiles.size"',
+      '"VideoFiles"."extname"': '"VideoFiles.extname"',
+      '"VideoFiles"."infoHash"': '"VideoFiles.infoHash"',
+      '"VideoFiles"."fps"': '"VideoFiles.fps"',
+      '"VideoFiles"."videoId"': '"VideoFiles.videoId"'
+    })
+  }
+
+  if (options.user) {
+    joins.push(
+      'LEFT OUTER JOIN "userVideoHistory" ' +
+      'ON "video"."id" = "userVideoHistory"."videoId" AND "userVideoHistory"."userId" = :userVideoHistoryId'
+    )
+    replacements.userVideoHistoryId = options.user.id
+
+    Object.assign(attributes, {
+      '"userVideoHistory"."id"': '"userVideoHistory.id"',
+      '"userVideoHistory"."currentTime"': '"userVideoHistory.currentTime"'
+    })
+  }
+
+  if (options.videoPlaylistId) {
+    joins.push(
+      'INNER JOIN "videoPlaylistElement" as "VideoPlaylistElement" ON "videoPlaylistElement"."videoId" = "video"."id" ' +
+      'AND "VideoPlaylistElement"."videoPlaylistId" = :videoPlaylistId'
+    )
+    replacements.videoPlaylistId = options.videoPlaylistId
+
+    Object.assign(attributes, {
+      '"VideoPlaylistElement"."createdAt"': '"VideoPlaylistElement.createdAt"',
+      '"VideoPlaylistElement"."updatedAt"': '"VideoPlaylistElement.updatedAt"',
+      '"VideoPlaylistElement"."url"': '"VideoPlaylistElement.url"',
+      '"VideoPlaylistElement"."position"': '"VideoPlaylistElement.position"',
+      '"VideoPlaylistElement"."startTimestamp"': '"VideoPlaylistElement.startTimestamp"',
+      '"VideoPlaylistElement"."stopTimestamp"': '"VideoPlaylistElement.stopTimestamp"',
+      '"VideoPlaylistElement"."videoPlaylistId"': '"VideoPlaylistElement.videoPlaylistId"'
+    })
+  }
+
+  const select = 'SELECT ' + Object.keys(attributes).map(key => {
+    const value = attributes[key]
+    if (value) return `${key} AS ${value}`
+
+    return key
+  }).join(', ')
+
+  return `${select} FROM (${baseQuery}) AS "tmp" ${joins.join(' ')} ${order}`
+}
+
 export {
-  buildListQuery
+  buildListQuery,
+  wrapForAPIResults
 }