PeerTube/server/models/utils.ts

281 lines
7.9 KiB
TypeScript
Raw Normal View History

2021-05-12 14:09:04 +02:00
import { literal, Op, OrderItem, Sequelize } from 'sequelize'
2019-04-18 11:28:17 +02:00
import { Col } from 'sequelize/types/lib/utils'
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
}
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 ],
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)
Handle blacklist (#84) * Client: Add list blacklist feature * Server: Add list blacklist feature * Client: Add videoId column * Server: Add some video infos in the REST api * Client: Add video information in the blacklist list * Fix sortable columns :) * Client: Add removeFromBlacklist feature * Server: Add removeFromBlacklist feature * Move to TypeScript * Move to TypeScript and Promises * Server: Fix blacklist list sort * Server: Fetch videos informations * Use common shared interface for client and server * Add check-params remove blacklisted video tests * Add check-params list blacklisted videos tests * Add list blacklist tests * Add remove from blacklist tests * Add video blacklist management tests * Fix rebase onto develop issues * Server: Add sort on blacklist id column * Server: Add blacklists library * Add blacklist id sort test * Add check-params tests for blacklist list pagination, count and sort * Fix coding style * Increase Remote API tests timeout * Increase Request scheduler API tests timeout * Fix typo * Increase video transcoding API tests timeout * Move tests to Typescript * Use lodash orderBy method * Fix typos * Client: Remove optional tests in blacklist model attributes * Move blacklist routes from 'blacklists' to 'blacklist' * CLient: Remove blacklist-list.component.scss * Rename 'blacklists' files to 'blacklist' * Use only BlacklistedVideo interface * Server: Use getFormattedObjects method in listBlacklist method * Client: Use new coding style * Server: Use new sort validator methods * Server: Use new checkParams methods * Client: Fix sortable columns
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 ]
Handle blacklist (#84) * Client: Add list blacklist feature * Server: Add list blacklist feature * Client: Add videoId column * Server: Add some video infos in the REST api * Client: Add video information in the blacklist list * Fix sortable columns :) * Client: Add removeFromBlacklist feature * Server: Add removeFromBlacklist feature * Move to TypeScript * Move to TypeScript and Promises * Server: Fix blacklist list sort * Server: Fetch videos informations * Use common shared interface for client and server * Add check-params remove blacklisted video tests * Add check-params list blacklisted videos tests * Add list blacklist tests * Add remove from blacklist tests * Add video blacklist management tests * Fix rebase onto develop issues * Server: Add sort on blacklist id column * Server: Add blacklists library * Add blacklist id sort test * Add check-params tests for blacklist list pagination, count and sort * Fix coding style * Increase Remote API tests timeout * Increase Request scheduler API tests timeout * Fix typo * Increase video transcoding API tests timeout * Move tests to Typescript * Use lodash orderBy method * Fix typos * Client: Remove optional tests in blacklist model attributes * Move blacklist routes from 'blacklists' to 'blacklist' * CLient: Remove blacklist-list.component.scss * Rename 'blacklists' files to 'blacklist' * Use only BlacklistedVideo interface * Server: Use getFormattedObjects method in listBlacklist method * Client: Use new coding style * Server: Use new sort validator methods * Server: Use new checkParams methods * Client: Fix sortable columns
2017-09-22 09:13:43 +02: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)
)
}
function buildBlockedAccountSQL (blockerIds: number[]) {
const blockerIdsString = blockerIds.join(', ')
2019-02-26 10:55:40 +01:00
return 'SELECT "targetAccountId" AS "id" FROM "accountBlocklist" WHERE "accountId" IN (' + blockerIdsString + ')' +
' UNION ' +
'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
}
2019-02-26 10:55:40 +01:00
function buildWhereIdOrUUID (id: number | string) {
return validator.isInt('' + id) ? { id } : { uuid: id }
}
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-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 {}
return {
2020-05-06 17:39:07 +02:00
[targetField]: {
[Op.iLike]: `%${sourceField}%`
}
}
}
2016-08-16 22:31:45 +02:00
// ---------------------------------------------------------------------------
2017-05-15 22:22:03 +02:00
export {
buildBlockedAccountSQL,
2020-08-20 08:52:16 +02:00
buildBlockedAccountSQLOptimized,
2019-08-06 17:19:53 +02:00
buildLocalActorIdsIn,
getPlaylistSort,
2018-08-14 15:28:30 +02:00
SortType,
2019-08-06 17:19:53 +02:00
buildLocalAccountIdsIn,
Handle blacklist (#84) * Client: Add list blacklist feature * Server: Add list blacklist feature * Client: Add videoId column * Server: Add some video infos in the REST api * Client: Add video information in the blacklist list * Fix sortable columns :) * Client: Add removeFromBlacklist feature * Server: Add removeFromBlacklist feature * Move to TypeScript * Move to TypeScript and Promises * Server: Fix blacklist list sort * Server: Fetch videos informations * Use common shared interface for client and server * Add check-params remove blacklisted video tests * Add check-params list blacklisted videos tests * Add list blacklist tests * Add remove from blacklist tests * Add video blacklist management tests * Fix rebase onto develop issues * Server: Add sort on blacklist id column * Server: Add blacklists library * Add blacklist id sort test * Add check-params tests for blacklist list pagination, count and sort * Fix coding style * Increase Remote API tests timeout * Increase Request scheduler API tests timeout * Fix typo * Increase video transcoding API tests timeout * Move tests to Typescript * Use lodash orderBy method * Fix typos * Client: Remove optional tests in blacklist model attributes * Move blacklist routes from 'blacklists' to 'blacklist' * CLient: Remove blacklist-list.component.scss * Rename 'blacklists' files to 'blacklist' * Use only BlacklistedVideo interface * Server: Use getFormattedObjects method in listBlacklist method * Client: Use new coding style * Server: Use new sort validator methods * Server: Use new checkParams methods * Client: Fix sortable columns
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,
parseAggregateResult,
getFollowsSort,
2020-03-05 15:04:57 +01:00
buildDirectionAndField,
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
}