X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmodels%2Futils.ts;h=1e168d41908edb54f7a9a49cc87e9cccfe34434b;hb=52d6c2e0bf0893e39d0a89fccebad684e9d61ce5;hp=5b4093aec40d7b2aee217810c437da749b167afd;hpb=88108880bbdba473cfe36ecbebc1c3c4f972e102;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/models/utils.ts b/server/models/utils.ts index 5b4093aec..1e168d419 100644 --- a/server/models/utils.ts +++ b/server/models/utils.ts @@ -1,25 +1,69 @@ -import { Sequelize } from 'sequelize-typescript' +import { literal, Op, OrderItem, Sequelize } from 'sequelize' +import validator from 'validator' -type SortType = { sortModel: any, sortValue: string } +type SortType = { sortModel: string, sortValue: string } // Translate for example "-name" to [ [ 'name', 'DESC' ], [ 'id', 'ASC' ] ] -function getSort (value: string, lastSort: string[] = [ 'id', 'ASC' ]) { - let { direction, field } = buildDirectionAndField(value) +function getSort (value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] { + const { direction, field } = buildDirectionAndField(value) + + let finalField: string | ReturnType if (field.toLowerCase() === 'match') { // Search - field = Sequelize.col('similarity') + finalField = Sequelize.col('similarity') + } else { + finalField = field } - return [ [ field, direction ], lastSort ] + return [ [ finalField, direction ], lastSort ] } -function getVideoSort (value: string, lastSort: string[] = [ 'id', 'ASC' ]) { - let { direction, field } = buildDirectionAndField(value) +function getAdminUsersSort (value: string): OrderItem[] { + const { direction, field } = buildDirectionAndField(value) - // Alias - if (field.toLowerCase() === 'match') { // Search - field = Sequelize.col('similarity') - } else if (field.toLowerCase() === 'trending') { // Sort by aggregation + let finalField: string | ReturnType + + if (field === 'videoQuotaUsed') { // Users list + finalField = Sequelize.col('videoQuotaUsed') + } else { + finalField = field + } + + const nullPolicy = direction === 'ASC' + ? 'NULLS FIRST' + : 'NULLS LAST' + + // FIXME: typings + return [ [ finalField as any, direction, nullPolicy ], [ 'id', 'ASC' ] ] +} + +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 ], @@ -27,23 +71,77 @@ function getVideoSort (value: string, lastSort: string[] = [ 'id', 'ASC' ]) { lastSort ] + } else if (field === 'publishedAt') { + return [ + [ 'ScheduleVideoUpdate', 'updateAt', direction + ' NULLS LAST' ], + + [ Sequelize.col('VideoModel.publishedAt'), direction ], + + lastSort + ] + } + + let finalField: string | ReturnType + + // Alias + if (field.toLowerCase() === 'match') { // Search + finalField = Sequelize.col('similarity') + } else { + finalField = field } - const firstSort = typeof field === 'string' ? - field.split('.').concat([ direction ]) : - [ field, direction ] + 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 getInstanceFollowsSort (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 getChannelSyncSort (value: string): OrderItem[] { + const { direction, field } = buildDirectionAndField(value) + if (field.toLowerCase() === 'videochannel') { + return [ + [ literal('"VideoChannel.name"'), direction ] + ] + } + return [ [ field, direction ] ] +} + +function isOutdated (model: { createdAt: Date, updatedAt: Date }, refreshInterval: number) { + if (!model.createdAt || !model.updatedAt) { + throw new Error('Miss createdAt & updatedAt attributes 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}.`) } @@ -52,7 +150,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' } @@ -68,46 +167,91 @@ function createSimilarityAttribute (col: string, value: string) { ) } -function buildBlockedAccountSQL (serverAccountId: number, userAccountId?: number) { - const blockerIds = [ serverAccountId ] - if (userAccountId) blockerIds.push(userAccountId) - +function buildBlockedAccountSQL (blockerIds: number[]) { const blockerIdsString = blockerIds.join(', ') - const query = 'SELECT "targetAccountId" AS "id" FROM "accountBlocklist" WHERE "accountId" IN (' + blockerIdsString + ')' + - ' UNION ALL ' + + 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})` + + `)` + ), - return query + 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) -export { - buildBlockedAccountSQL, - SortType, - getSort, - getVideoSort, - getSortOnModel, - createSimilarityAttribute, - throwIfNotValid, - buildTrigramSearchIndex + 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 searchTrigramNormalizeValue (value: string) { - return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', value)) +function parseAggregateResult (result: any) { + if (!result) return 0 + + const total = parseInt(result + '', 10) + if (isNaN(total)) return 0 + + return total } -function searchTrigramNormalizeCol (col: string) { - return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', Sequelize.col(col))) +function parseRowCountResult (result: any) { + if (result.length !== 0) return result[0].total + + return 0 +} + +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: any + let field: string let direction: 'ASC' | 'DESC' if (value.substring(0, 1) === '-') { @@ -120,3 +264,53 @@ function buildDirectionAndField (value: string) { return { direction, field } } + +function searchAttribute (sourceField?: string, targetField?: string) { + if (!sourceField) return {} + + return { + [targetField]: { + // FIXME: ts error + [Op.iLike as any]: `%${sourceField}%` + } + } +} + +// --------------------------------------------------------------------------- + +export { + buildBlockedAccountSQL, + buildBlockedAccountSQLOptimized, + buildLocalActorIdsIn, + getPlaylistSort, + SortType, + buildLocalAccountIdsIn, + getSort, + getCommentSort, + getAdminUsersSort, + getVideoSort, + getBlacklistSort, + getChannelSyncSort, + createSimilarityAttribute, + throwIfNotValid, + buildServerIdsFollowedBy, + buildTrigramSearchIndex, + buildWhereIdOrUUID, + isOutdated, + parseAggregateResult, + getInstanceFollowsSort, + buildDirectionAndField, + createSafeIn, + searchAttribute, + parseRowCountResult +} + +// --------------------------------------------------------------------------- + +function searchTrigramNormalizeValue (value: string) { + return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', value)) +} + +function searchTrigramNormalizeCol (col: string) { + return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', Sequelize.col(col))) +}