X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;ds=sidebyside;f=server%2Fmodels%2Futils.ts;h=93723816f29bc499a49349c7ec9a13beadc1bd27;hb=a8749f7c3b137f433e6944bb99fd721a6f0cfc1e;hp=24890f961e5d1d2738d0148b37d6561469cf445b;hpb=6b9c966f6428c9e47bead3410a0401e8ebd744bf;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/models/utils.ts b/server/models/utils.ts index 24890f961..93723816f 100644 --- a/server/models/utils.ts +++ b/server/models/utils.ts @@ -1,20 +1,18 @@ -import { Model, Sequelize } from 'sequelize-typescript' -import * as validator from 'validator' -import { Col } from 'sequelize/types/lib/utils' -import { OrderItem, literal } from 'sequelize' +import { literal, Model, ModelStatic, Op, OrderItem, Sequelize } from 'sequelize' +import validator from 'validator' +import { forceNumber } from '@shared/core-utils' +import { AttributesOnly } from '@shared/typescript-utils' -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: OrderItem = [ 'id', 'ASC' ]): OrderItem[] { const { direction, field } = buildDirectionAndField(value) - let finalField: string | Col + let finalField: string | ReturnType if (field.toLowerCase() === 'match') { // Search finalField = Sequelize.col('similarity') - } else if (field === 'videoQuotaUsed') { // Users list - finalField = Sequelize.col('videoQuotaUsed') } else { finalField = field } @@ -22,6 +20,48 @@ function getSort (value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderIt return [ [ finalField, direction ], lastSort ] } +function getAdminUsersSort (value: string): OrderItem[] { + const { direction, field } = buildDirectionAndField(value) + + 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) @@ -31,11 +71,19 @@ function getVideoSort (value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): Or [ 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 + let finalField: string | ReturnType // Alias if (field.toLowerCase() === 'match') { // Search @@ -44,21 +92,48 @@ function getVideoSort (value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): Or finalField = field } - const firstSort = typeof finalField === 'string' - ? finalField.split('.').concat([ direction ]) as any // FIXME: sequelize typings + const firstSort: OrderItem = typeof finalField === 'string' + ? finalField.split('.').concat([ direction ]) as OrderItem : [ finalField, direction ] return [ firstSort, lastSort ] } -function getSortOnModel (model: any, value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] { +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 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() @@ -77,7 +152,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' } @@ -93,21 +169,18 @@ 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(', ') return 'SELECT "targetAccountId" AS "id" FROM "accountBlocklist" WHERE "accountId" IN (' + blockerIdsString + ')' + - ' UNION ALL ' + + ' 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 buildServerIdsFollowedBy (actorId: any) { - const actorIdNumber = parseInt(actorId + '', 10) + const actorIdNumber = forceNumber(actorId) return '(' + 'SELECT "actor"."serverId" FROM "actorFollow" ' + @@ -123,15 +196,24 @@ function buildWhereIdOrUUID (id: number | string) { function parseAggregateResult (result: any) { if (!result) return 0 - const total = parseInt(result + '', 10) + const total = forceNumber(result) if (isNaN(total)) return 0 return total } -const createSafeIn = (model: typeof Model, stringArr: (string | number)[]) => { - return stringArr.map(t => model.sequelize.escape('' + t)) - .join(', ') +function parseRowCountResult (result: any) { + if (result.length !== 0) return result[0].total + + return 0 +} + +function createSafeIn (sequelize: Sequelize, toEscape: (string | number)[], additionalUnescaped: string[] = []) { + return toEscape.map(t => { + return t === null + ? null + : sequelize.escape('' + t) + }).concat(additionalUnescaped).join(', ') } function buildLocalAccountIdsIn () { @@ -146,16 +228,70 @@ function buildLocalActorIdsIn () { ) } +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]: { + // FIXME: ts error + [Op.iLike as any]: `%${sourceField}%` + } + } +} + +function buildSQLAttributes (options: { + model: ModelStatic + tableName: string + + excludeAttributes?: Exclude, symbol>[] + aliasPrefix?: string +}) { + const { model, tableName, aliasPrefix, excludeAttributes } = options + + const attributes = Object.keys(model.getAttributes()) as Exclude, symbol>[] + + return attributes + .filter(a => { + if (!excludeAttributes) return true + if (excludeAttributes.includes(a)) return false + + return true + }) + .map(a => { + return `"${tableName}"."${a}" AS "${aliasPrefix || ''}${a}"` + }) +} + // --------------------------------------------------------------------------- export { + buildSQLAttributes, buildBlockedAccountSQL, buildLocalActorIdsIn, + getPlaylistSort, SortType, buildLocalAccountIdsIn, getSort, + getCommentSort, + getAdminUsersSort, getVideoSort, - getSortOnModel, + getBlacklistSort, + getChannelSyncSort, createSimilarityAttribute, throwIfNotValid, buildServerIdsFollowedBy, @@ -163,7 +299,11 @@ export { buildWhereIdOrUUID, isOutdated, parseAggregateResult, - createSafeIn + getInstanceFollowsSort, + buildDirectionAndField, + createSafeIn, + searchAttribute, + parseRowCountResult } // --------------------------------------------------------------------------- @@ -175,18 +315,3 @@ function searchTrigramNormalizeValue (value: string) { function searchTrigramNormalizeCol (col: string) { return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', Sequelize.col(col))) } - -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 } -}