2021-05-12 14:09:04 +02:00
|
|
|
import { literal, Op, OrderItem, Sequelize } from 'sequelize'
|
2022-02-09 13:44:02 +01:00
|
|
|
import { Col } from 'sequelize/types/utils'
|
2020-12-01 15:08:59 +01:00
|
|
|
import validator from 'validator'
|
2018-07-19 16:17:54 +02:00
|
|
|
|
2019-09-04 16:23:37 +02:00
|
|
|
type SortType = { sortModel: string, sortValue: string }
|
2018-08-14 15:28:30 +02:00
|
|
|
|
2018-08-31 17:18:13 +02:00
|
|
|
// Translate for example "-name" to [ [ 'name', 'DESC' ], [ 'id', 'ASC' ] ]
|
2019-04-18 11:28:17 +02:00
|
|
|
function getSort (value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] {
|
|
|
|
const { direction, field } = buildDirectionAndField(value)
|
|
|
|
|
|
|
|
let finalField: string | Col
|
2018-08-31 17:32:35 +02:00
|
|
|
|
|
|
|
if (field.toLowerCase() === 'match') { // Search
|
2019-04-18 11:28:17 +02:00
|
|
|
finalField = Sequelize.col('similarity')
|
2019-07-25 11:15:03 +02:00
|
|
|
} else if (field === 'videoQuotaUsed') { // Users list
|
|
|
|
finalField = Sequelize.col('videoQuotaUsed')
|
2019-04-18 11:28:17 +02:00
|
|
|
} else {
|
|
|
|
finalField = field
|
2018-08-31 17:32:35 +02:00
|
|
|
}
|
2016-08-16 22:31:45 +02:00
|
|
|
|
2019-04-18 11:28:17 +02:00
|
|
|
return [ [ finalField, direction ], lastSort ]
|
2018-08-31 17:18:13 +02:00
|
|
|
}
|
|
|
|
|
2020-12-01 15:08:59 +01:00
|
|
|
function getPlaylistSort (value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] {
|
|
|
|
const { direction, field } = buildDirectionAndField(value)
|
|
|
|
|
|
|
|
if (field.toLowerCase() === 'name') {
|
|
|
|
return [ [ 'displayName', direction ], lastSort ]
|
|
|
|
}
|
|
|
|
|
|
|
|
return getSort(value, lastSort)
|
|
|
|
}
|
|
|
|
|
2019-12-27 17:02:34 +01:00
|
|
|
function getCommentSort (value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] {
|
|
|
|
const { direction, field } = buildDirectionAndField(value)
|
|
|
|
|
|
|
|
if (field === 'totalReplies') {
|
|
|
|
return [
|
|
|
|
[ Sequelize.literal('"totalReplies"'), direction ],
|
|
|
|
lastSort
|
|
|
|
]
|
|
|
|
}
|
|
|
|
|
|
|
|
return getSort(value, lastSort)
|
|
|
|
}
|
|
|
|
|
2019-04-18 11:28:17 +02:00
|
|
|
function getVideoSort (value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] {
|
|
|
|
const { direction, field } = buildDirectionAndField(value)
|
2016-08-16 22:31:45 +02:00
|
|
|
|
2019-04-18 11:28:17 +02:00
|
|
|
if (field.toLowerCase() === 'trending') { // Sort by aggregation
|
2018-08-31 17:18:13 +02:00
|
|
|
return [
|
|
|
|
[ Sequelize.fn('COALESCE', Sequelize.fn('SUM', Sequelize.col('VideoViews.views')), '0'), direction ],
|
|
|
|
|
|
|
|
[ Sequelize.col('VideoModel.views'), direction ],
|
|
|
|
|
2021-02-26 14:08:09 +01:00
|
|
|
lastSort
|
|
|
|
]
|
|
|
|
} else if (field === 'publishedAt') {
|
|
|
|
return [
|
|
|
|
[ 'ScheduleVideoUpdate', 'updateAt', direction + ' NULLS LAST' ],
|
|
|
|
|
|
|
|
[ Sequelize.col('VideoModel.publishedAt'), direction ],
|
|
|
|
|
2018-08-31 17:18:13 +02:00
|
|
|
lastSort
|
|
|
|
]
|
|
|
|
}
|
|
|
|
|
2019-04-18 11:28:17 +02:00
|
|
|
let finalField: string | Col
|
|
|
|
|
|
|
|
// Alias
|
|
|
|
if (field.toLowerCase() === 'match') { // Search
|
|
|
|
finalField = Sequelize.col('similarity')
|
|
|
|
} else {
|
|
|
|
finalField = field
|
|
|
|
}
|
|
|
|
|
2021-10-22 16:39:37 +02:00
|
|
|
const firstSort: OrderItem = typeof finalField === 'string'
|
|
|
|
? finalField.split('.').concat([ direction ]) as OrderItem
|
2019-04-18 11:28:17 +02:00
|
|
|
: [ finalField, direction ]
|
2018-12-18 11:52:20 +01:00
|
|
|
|
|
|
|
return [ firstSort, lastSort ]
|
2016-08-16 22:31:45 +02:00
|
|
|
}
|
|
|
|
|
2019-09-04 16:23:37 +02:00
|
|
|
function getBlacklistSort (model: any, value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] {
|
2019-04-18 11:28:17 +02:00
|
|
|
const [ firstSort ] = getSort(value)
|
2017-09-22 09:13:43 +02:00
|
|
|
|
2021-10-22 16:39:37 +02:00
|
|
|
if (model) return [ [ literal(`"${model}.${firstSort[0]}" ${firstSort[1]}`) ], lastSort ] as OrderItem[]
|
2018-02-19 09:41:03 +01:00
|
|
|
return [ firstSort, lastSort ]
|
2017-09-22 09:13:43 +02:00
|
|
|
}
|
|
|
|
|
2019-11-29 11:16:43 +01:00
|
|
|
function getFollowsSort (value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] {
|
|
|
|
const { direction, field } = buildDirectionAndField(value)
|
|
|
|
|
|
|
|
if (field === 'redundancyAllowed') {
|
|
|
|
return [
|
|
|
|
[ 'ActorFollowing', 'Server', 'redundancyAllowed', direction ],
|
|
|
|
lastSort
|
|
|
|
]
|
|
|
|
}
|
|
|
|
|
|
|
|
return getSort(value, lastSort)
|
|
|
|
}
|
|
|
|
|
2019-03-19 14:13:53 +01:00
|
|
|
function isOutdated (model: { createdAt: Date, updatedAt: Date }, refreshInterval: number) {
|
2021-06-02 15:47:05 +02:00
|
|
|
if (!model.createdAt || !model.updatedAt) {
|
|
|
|
throw new Error('Miss createdAt & updatedAt attribuets to model')
|
|
|
|
}
|
|
|
|
|
2019-03-19 14:13:53 +01:00
|
|
|
const now = Date.now()
|
|
|
|
const createdAtTime = model.createdAt.getTime()
|
|
|
|
const updatedAtTime = model.updatedAt.getTime()
|
|
|
|
|
|
|
|
return (now - createdAtTime) > refreshInterval && (now - updatedAtTime) > refreshInterval
|
|
|
|
}
|
|
|
|
|
2019-04-18 11:28:17 +02:00
|
|
|
function throwIfNotValid (value: any, validator: (value: any) => boolean, fieldName = 'value', nullable = false) {
|
|
|
|
if (nullable && (value === null || value === undefined)) return
|
|
|
|
|
2017-12-12 17:53:50 +01:00
|
|
|
if (validator(value) === false) {
|
|
|
|
throw new Error(`"${value}" is not a valid ${fieldName}.`)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-07-19 16:17:54 +02:00
|
|
|
function buildTrigramSearchIndex (indexName: string, attribute: string) {
|
|
|
|
return {
|
|
|
|
name: indexName,
|
2020-12-08 14:30:29 +01:00
|
|
|
// FIXME: gin_trgm_ops is not taken into account in Sequelize 6, so adding it ourselves in the literal function
|
|
|
|
fields: [ Sequelize.literal('lower(immutable_unaccent(' + attribute + ')) gin_trgm_ops') as any ],
|
2018-07-19 16:17:54 +02:00
|
|
|
using: 'gin',
|
|
|
|
operator: 'gin_trgm_ops'
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
function createSimilarityAttribute (col: string, value: string) {
|
|
|
|
return Sequelize.fn(
|
|
|
|
'similarity',
|
|
|
|
|
|
|
|
searchTrigramNormalizeCol(col),
|
|
|
|
|
|
|
|
searchTrigramNormalizeValue(value)
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
2020-05-22 17:06:26 +02:00
|
|
|
function buildBlockedAccountSQL (blockerIds: number[]) {
|
2018-10-12 15:26:04 +02:00
|
|
|
const blockerIdsString = blockerIds.join(', ')
|
|
|
|
|
2019-02-26 10:55:40 +01:00
|
|
|
return 'SELECT "targetAccountId" AS "id" FROM "accountBlocklist" WHERE "accountId" IN (' + blockerIdsString + ')' +
|
2021-02-19 09:50:13 +01:00
|
|
|
' UNION ' +
|
2018-10-12 15:26:04 +02:00
|
|
|
'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 (' + blockerIdsString + ')'
|
2019-02-26 10:55:40 +01:00
|
|
|
}
|
|
|
|
|
2020-08-20 08:52:16 +02:00
|
|
|
function buildBlockedAccountSQLOptimized (columnNameJoin: string, blockerIds: number[]) {
|
|
|
|
const blockerIdsString = blockerIds.join(', ')
|
|
|
|
|
|
|
|
return [
|
|
|
|
literal(
|
|
|
|
`NOT EXISTS (` +
|
|
|
|
` SELECT 1 FROM "accountBlocklist" ` +
|
|
|
|
` WHERE "targetAccountId" = ${columnNameJoin} ` +
|
|
|
|
` AND "accountId" IN (${blockerIdsString})` +
|
|
|
|
`)`
|
|
|
|
),
|
|
|
|
|
|
|
|
literal(
|
|
|
|
`NOT EXISTS (` +
|
|
|
|
` SELECT 1 FROM "account" ` +
|
|
|
|
` INNER JOIN "actor" ON account."actorId" = actor.id ` +
|
|
|
|
` INNER JOIN "serverBlocklist" ON "actor"."serverId" = "serverBlocklist"."targetServerId" ` +
|
|
|
|
` WHERE "account"."id" = ${columnNameJoin} ` +
|
|
|
|
` AND "serverBlocklist"."accountId" IN (${blockerIdsString})` +
|
|
|
|
`)`
|
|
|
|
)
|
|
|
|
]
|
|
|
|
}
|
|
|
|
|
2019-02-26 10:55:40 +01:00
|
|
|
function buildServerIdsFollowedBy (actorId: any) {
|
|
|
|
const actorIdNumber = parseInt(actorId + '', 10)
|
|
|
|
|
|
|
|
return '(' +
|
|
|
|
'SELECT "actor"."serverId" FROM "actorFollow" ' +
|
|
|
|
'INNER JOIN "actor" ON actor.id = "actorFollow"."targetActorId" ' +
|
|
|
|
'WHERE "actorFollow"."actorId" = ' + actorIdNumber +
|
2020-01-31 16:56:52 +01:00
|
|
|
')'
|
2019-02-26 10:55:40 +01:00
|
|
|
}
|
2018-10-12 15:26:04 +02:00
|
|
|
|
2019-02-26 10:55:40 +01:00
|
|
|
function buildWhereIdOrUUID (id: number | string) {
|
|
|
|
return validator.isInt('' + id) ? { id } : { uuid: id }
|
2018-10-12 15:26:04 +02:00
|
|
|
}
|
|
|
|
|
2019-04-23 09:50:57 +02:00
|
|
|
function parseAggregateResult (result: any) {
|
|
|
|
if (!result) return 0
|
|
|
|
|
|
|
|
const total = parseInt(result + '', 10)
|
|
|
|
if (isNaN(total)) return 0
|
|
|
|
|
|
|
|
return total
|
|
|
|
}
|
|
|
|
|
2021-05-12 14:09:04 +02:00
|
|
|
function createSafeIn (sequelize: Sequelize, stringArr: (string | number)[]) {
|
2020-03-05 15:04:57 +01:00
|
|
|
return stringArr.map(t => {
|
|
|
|
return t === null
|
|
|
|
? null
|
2021-05-12 14:09:04 +02:00
|
|
|
: sequelize.escape('' + t)
|
2020-03-05 15:04:57 +01:00
|
|
|
}).join(', ')
|
2019-06-19 14:55:58 +02:00
|
|
|
}
|
|
|
|
|
2019-08-06 17:19:53 +02:00
|
|
|
function buildLocalAccountIdsIn () {
|
|
|
|
return literal(
|
|
|
|
'(SELECT "account"."id" FROM "account" INNER JOIN "actor" ON "actor"."id" = "account"."actorId" AND "actor"."serverId" IS NULL)'
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
|
|
|
function buildLocalActorIdsIn () {
|
|
|
|
return literal(
|
|
|
|
'(SELECT "actor"."id" FROM "actor" WHERE "actor"."serverId" IS NULL)'
|
|
|
|
)
|
|
|
|
}
|
|
|
|
|
2020-03-05 15:04:57 +01:00
|
|
|
function buildDirectionAndField (value: string) {
|
|
|
|
let field: string
|
|
|
|
let direction: 'ASC' | 'DESC'
|
|
|
|
|
|
|
|
if (value.substring(0, 1) === '-') {
|
|
|
|
direction = 'DESC'
|
|
|
|
field = value.substring(1)
|
|
|
|
} else {
|
|
|
|
direction = 'ASC'
|
|
|
|
field = value
|
|
|
|
}
|
|
|
|
|
|
|
|
return { direction, field }
|
|
|
|
}
|
|
|
|
|
2020-05-06 17:39:07 +02:00
|
|
|
function searchAttribute (sourceField?: string, targetField?: string) {
|
|
|
|
if (!sourceField) return {}
|
2020-05-02 22:38:18 +02:00
|
|
|
|
|
|
|
return {
|
2020-05-06 17:39:07 +02:00
|
|
|
[targetField]: {
|
2022-01-14 14:15:23 +01:00
|
|
|
// FIXME: ts error
|
|
|
|
[Op.iLike as any]: `%${sourceField}%`
|
2020-05-06 17:39:07 +02:00
|
|
|
}
|
2020-05-02 22:38:18 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-08-16 22:31:45 +02:00
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
2017-05-15 22:22:03 +02:00
|
|
|
export {
|
2018-10-12 15:26:04 +02:00
|
|
|
buildBlockedAccountSQL,
|
2020-08-20 08:52:16 +02:00
|
|
|
buildBlockedAccountSQLOptimized,
|
2019-08-06 17:19:53 +02:00
|
|
|
buildLocalActorIdsIn,
|
2020-12-01 15:08:59 +01:00
|
|
|
getPlaylistSort,
|
2018-08-14 15:28:30 +02:00
|
|
|
SortType,
|
2019-08-06 17:19:53 +02:00
|
|
|
buildLocalAccountIdsIn,
|
2017-09-22 09:13:43 +02:00
|
|
|
getSort,
|
2019-12-27 17:02:34 +01:00
|
|
|
getCommentSort,
|
2018-08-31 17:18:13 +02:00
|
|
|
getVideoSort,
|
2019-09-04 16:23:37 +02:00
|
|
|
getBlacklistSort,
|
2018-07-19 16:17:54 +02:00
|
|
|
createSimilarityAttribute,
|
|
|
|
throwIfNotValid,
|
2019-02-26 10:55:40 +01:00
|
|
|
buildServerIdsFollowedBy,
|
|
|
|
buildTrigramSearchIndex,
|
2019-03-19 14:13:53 +01:00
|
|
|
buildWhereIdOrUUID,
|
2019-04-23 09:50:57 +02:00
|
|
|
isOutdated,
|
2019-06-19 14:55:58 +02:00
|
|
|
parseAggregateResult,
|
2019-11-29 11:16:43 +01:00
|
|
|
getFollowsSort,
|
2020-03-05 15:04:57 +01:00
|
|
|
buildDirectionAndField,
|
2020-04-19 14:11:40 +02:00
|
|
|
createSafeIn,
|
2020-05-06 17:39:07 +02:00
|
|
|
searchAttribute
|
2018-07-19 16:17:54 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
function searchTrigramNormalizeValue (value: string) {
|
2018-07-26 10:45:10 +02:00
|
|
|
return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', value))
|
2018-07-19 16:17:54 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
function searchTrigramNormalizeCol (col: string) {
|
|
|
|
return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', Sequelize.col(col)))
|
2017-05-15 22:22:03 +02:00
|
|
|
}
|