server/models/utils.ts

   1 import { Sequelize } from 'sequelize-typescript'
   2 import * as validator from 'validator'
   3
   4 type SortType = { sortModel: any, sortValue: string }
   5
   6 // Translate for example "-name" to [ [ 'name', 'DESC' ], [ 'id', 'ASC' ] ]
   7 function getSort (value: string, lastSort: string[] = [ 'id', 'ASC' ]) {
   8   let { direction, field } = buildDirectionAndField(value)
   9
  10   if (field.toLowerCase() === 'match') { // Search
  11     field = Sequelize.col('similarity')
  12   }
  13
  14   return [ [ field, direction ], lastSort ]
  15 }
  16
  17 function getVideoSort (value: string, lastSort: string[] = [ 'id', 'ASC' ]) {
  18   let { direction, field } = buildDirectionAndField(value)
  19
  20   // Alias
  21   if (field.toLowerCase() === 'match') { // Search
  22     field = Sequelize.col('similarity')
  23   } else if (field.toLowerCase() === 'trending') { // Sort by aggregation
  24     return [
  25       [ Sequelize.fn('COALESCE', Sequelize.fn('SUM', Sequelize.col('VideoViews.views')), '0'), direction ],
  26
  27       [ Sequelize.col('VideoModel.views'), direction ],
  28
  29       lastSort
  30     ]
  31   }
  32
  33   const firstSort = typeof field === 'string' ?
  34     field.split('.').concat([ direction ]) :
  35     [ field, direction ]
  36
  37   return [ firstSort, lastSort ]
  38 }
  39
  40 function getSortOnModel (model: any, value: string, lastSort: string[] = [ 'id', 'ASC' ]) {
  41   let [ firstSort ] = getSort(value)
  42
  43   if (model) return [ [ model, firstSort[0], firstSort[1] ], lastSort ]
  44   return [ firstSort, lastSort ]
  45 }
  46
  47 function throwIfNotValid (value: any, validator: (value: any) => boolean, fieldName = 'value') {
  48   if (validator(value) === false) {
  49     throw new Error(`"${value}" is not a valid ${fieldName}.`)
  50   }
  51 }
  52
  53 function buildTrigramSearchIndex (indexName: string, attribute: string) {
  54   return {
  55     name: indexName,
  56     fields: [ Sequelize.literal('lower(immutable_unaccent(' + attribute + '))') as any ],
  57     using: 'gin',
  58     operator: 'gin_trgm_ops'
  59   }
  60 }
  61
  62 function createSimilarityAttribute (col: string, value: string) {
  63   return Sequelize.fn(
  64     'similarity',
  65
  66     searchTrigramNormalizeCol(col),
  67
  68     searchTrigramNormalizeValue(value)
  69   )
  70 }
  71
  72 function buildBlockedAccountSQL (serverAccountId: number, userAccountId?: number) {
  73   const blockerIds = [ serverAccountId ]
  74   if (userAccountId) blockerIds.push(userAccountId)
  75
  76   const blockerIdsString = blockerIds.join(', ')
  77
  78   return 'SELECT "targetAccountId" AS "id" FROM "accountBlocklist" WHERE "accountId" IN (' + blockerIdsString + ')' +
  79     ' UNION ALL ' +
  80     'SELECT "account"."id" AS "id" FROM account INNER JOIN "actor" ON account."actorId" = actor.id ' +
  81     'INNER JOIN "serverBlocklist" ON "actor"."serverId" = "serverBlocklist"."targetServerId" ' +
  82     'WHERE "serverBlocklist"."accountId" IN (' + blockerIdsString + ')'
  83 }
  84
  85 function buildServerIdsFollowedBy (actorId: any) {
  86   const actorIdNumber = parseInt(actorId + '', 10)
  87
  88   return '(' +
  89     'SELECT "actor"."serverId" FROM "actorFollow" ' +
  90     'INNER JOIN "actor" ON actor.id = "actorFollow"."targetActorId" ' +
  91     'WHERE "actorFollow"."actorId" = ' + actorIdNumber +
  92   ')'
  93 }
  94
  95 function buildWhereIdOrUUID (id: number | string) {
  96   return validator.isInt('' + id) ? { id } : { uuid: id }
  97 }
  98
  99 // ---------------------------------------------------------------------------
 100
 101 export {
 102   buildBlockedAccountSQL,
 103   SortType,
 104   getSort,
 105   getVideoSort,
 106   getSortOnModel,
 107   createSimilarityAttribute,
 108   throwIfNotValid,
 109   buildServerIdsFollowedBy,
 110   buildTrigramSearchIndex,
 111   buildWhereIdOrUUID
 112 }
 113
 114 // ---------------------------------------------------------------------------
 115
 116 function searchTrigramNormalizeValue (value: string) {
 117   return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', value))
 118 }
 119
 120 function searchTrigramNormalizeCol (col: string) {
 121   return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', Sequelize.col(col)))
 122 }
 123
 124 function buildDirectionAndField (value: string) {
 125   let field: any
 126   let direction: 'ASC' | 'DESC'
 127
 128   if (value.substring(0, 1) === '-') {
 129     direction = 'DESC'
 130     field = value.substring(1)
 131   } else {
 132     direction = 'ASC'
 133     field = value
 134   }
 135
 136   return { direction, field }
 137 }