X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmodels%2Futils.ts;h=6a109056ff964c621d2694edb961c8380e1a126b;hb=21d68e68039a1eefbe6213fbde46e737e520ee7d;hp=393f8f03631f073e3e159db0cd86121ad9d1fdb5;hpb=d525fc399a14a8b16eaad6d4c0bc0a9c4093c3c9;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/models/utils.ts b/server/models/utils.ts index 393f8f036..6a109056f 100644 --- a/server/models/utils.ts +++ b/server/models/utils.ts @@ -1,32 +1,121 @@ +import { literal, Op, OrderItem, Sequelize } from 'sequelize' +import { Col } from 'sequelize/types/lib/utils' +import validator from 'validator' + +type SortType = { sortModel: string, sortValue: string } + // Translate for example "-name" to [ [ 'name', 'DESC' ], [ 'id', 'ASC' ] ] -import { Sequelize } from 'sequelize-typescript' +function getSort (value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] { + const { direction, field } = buildDirectionAndField(value) -function getSort (value: string, lastSort: string[] = [ 'id', 'ASC' ]) { - let field: any - let direction: 'ASC' | 'DESC' + let finalField: string | Col - if (value.substring(0, 1) === '-') { - direction = 'DESC' - field = value.substring(1) + if (field.toLowerCase() === 'match') { // Search + finalField = Sequelize.col('similarity') + } else if (field === 'videoQuotaUsed') { // Users list + finalField = Sequelize.col('videoQuotaUsed') } else { - direction = 'ASC' - field = value + finalField = field + } + + return [ [ finalField, direction ], lastSort ] +} + +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) +} + +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) +} + +function getVideoSort (value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] { + const { direction, field } = buildDirectionAndField(value) + + if (field.toLowerCase() === 'trending') { // Sort by aggregation + 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 ], + + lastSort + ] + } + + let finalField: string | Col + // Alias - if (field.toLowerCase() === 'match') field = Sequelize.col('similarity') + if (field.toLowerCase() === 'match') { // Search + finalField = Sequelize.col('similarity') + } else { + finalField = field + } - return [ [ field, direction ], lastSort ] + const firstSort: OrderItem = typeof finalField === 'string' + ? finalField.split('.').concat([ direction ]) as OrderItem + : [ finalField, direction ] + + return [ firstSort, lastSort ] } -function getSortOnModel (model: any, value: string, lastSort: string[] = [ 'id', 'ASC' ]) { - let [ firstSort ] = getSort(value) +function getBlacklistSort (model: any, value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] { + const [ firstSort ] = getSort(value) - if (model) return [ [ model, firstSort[0], firstSort[1] ], lastSort ] + if (model) return [ [ literal(`"${model}.${firstSort[0]}" ${firstSort[1]}`) ], lastSort ] as OrderItem[] return [ firstSort, lastSort ] } -function throwIfNotValid (value: any, validator: (value: any) => boolean, fieldName = 'value') { +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) +} + +function isOutdated (model: { createdAt: Date, updatedAt: Date }, refreshInterval: number) { + if (!model.createdAt || !model.updatedAt) { + throw new Error('Miss createdAt & updatedAt attribuets to model') + } + + const now = Date.now() + const createdAtTime = model.createdAt.getTime() + const updatedAtTime = model.updatedAt.getTime() + + return (now - createdAtTime) > refreshInterval && (now - updatedAtTime) > refreshInterval +} + +function throwIfNotValid (value: any, validator: (value: any) => boolean, fieldName = 'value', nullable = false) { + if (nullable && (value === null || value === undefined)) return + if (validator(value) === false) { throw new Error(`"${value}" is not a valid ${fieldName}.`) } @@ -35,7 +124,8 @@ function throwIfNotValid (value: any, validator: (value: any) => boolean, fieldN function buildTrigramSearchIndex (indexName: string, attribute: string) { return { name: indexName, - fields: [ Sequelize.literal('lower(immutable_unaccent(' + attribute + '))') as any ], + // 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 ], using: 'gin', operator: 'gin_trgm_ops' } @@ -51,32 +141,138 @@ function createSimilarityAttribute (col: string, value: string) { ) } -function createSearchTrigramQuery (col: string, value: string) { - return { - [ Sequelize.Op.or ]: [ - // FIXME: use word_similarity instead of just similarity? - Sequelize.where(searchTrigramNormalizeCol(col), ' % ', searchTrigramNormalizeValue(value)), +function buildBlockedAccountSQL (blockerIds: number[]) { + const blockerIdsString = blockerIds.join(', ') - Sequelize.where(searchTrigramNormalizeCol(col), ' LIKE ', searchTrigramNormalizeValue(`%${value}%`)) - ] + 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 + ')' +} + +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})` + + `)` + ) + ] +} + +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 + + ')' +} + +function buildWhereIdOrUUID (id: number | string) { + return validator.isInt('' + id) ? { id } : { uuid: id } +} + +function parseAggregateResult (result: any) { + if (!result) return 0 + + const total = parseInt(result + '', 10) + if (isNaN(total)) return 0 + + return total +} + +function createSafeIn (sequelize: Sequelize, stringArr: (string | number)[]) { + return stringArr.map(t => { + return t === null + ? null + : sequelize.escape('' + t) + }).join(', ') +} + +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)' + ) +} + +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 } +} + +function searchAttribute (sourceField?: string, targetField?: string) { + if (!sourceField) return {} + + return { + [targetField]: { + [Op.iLike]: `%${sourceField}%` + } } } // --------------------------------------------------------------------------- export { + buildBlockedAccountSQL, + buildBlockedAccountSQLOptimized, + buildLocalActorIdsIn, + getPlaylistSort, + SortType, + buildLocalAccountIdsIn, getSort, - getSortOnModel, + getCommentSort, + getVideoSort, + getBlacklistSort, createSimilarityAttribute, throwIfNotValid, + buildServerIdsFollowedBy, buildTrigramSearchIndex, - createSearchTrigramQuery + buildWhereIdOrUUID, + isOutdated, + parseAggregateResult, + getFollowsSort, + buildDirectionAndField, + createSafeIn, + searchAttribute } // --------------------------------------------------------------------------- function searchTrigramNormalizeValue (value: string) { - return Sequelize.fn('lower', Sequelize.fn('unaccent', value)) + return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', value)) } function searchTrigramNormalizeCol (col: string) {