X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmodels%2Futils.ts;h=e7e6ddde1f61e6c86117b4fa073f32bf6ebfe45e;hb=951532924c1b3fd547cbf45f0c9cf9734203d6b4;hp=1bf61d2a693021aff86a88732587dfabe3ccd87b;hpb=792dbaf07f83fbe3f1d209cd9edf190442c7d2f3;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/models/utils.ts b/server/models/utils.ts index 1bf61d2a6..e7e6ddde1 100644 --- a/server/models/utils.ts +++ b/server/models/utils.ts @@ -1,35 +1,192 @@ -// Translate for example "-name" to [ 'name', 'DESC' ] -function getSort (value: string) { - let field: string - let direction: 'ASC' | 'DESC' +import { Model, Sequelize } from 'sequelize-typescript' +import * as validator from 'validator' +import { Col } from 'sequelize/types/lib/utils' +import { col, literal, OrderItem } from 'sequelize' - if (value.substring(0, 1) === '-') { - direction = 'DESC' - field = value.substring(1) +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 + + 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 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 + ] + } + + let finalField: string | Col + + // Alias + if (field.toLowerCase() === 'match') { // Search + finalField = Sequelize.col('similarity') + } else { + finalField = field + } + + const firstSort = typeof finalField === 'string' + ? finalField.split('.').concat([ direction ]) as any // FIXME: sequelize typings + : [ finalField, direction ] + + return [ firstSort, lastSort ] +} + +function getBlacklistSort (model: any, value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] { + const [ firstSort ] = getSort(value) + + if (model) return [ [ literal(`"${model}.${firstSort[ 0 ]}" ${firstSort[ 1 ]}`) ], lastSort ] as any[] // FIXME: typings + return [ firstSort, lastSort ] +} + +function isOutdated (model: { createdAt: Date, updatedAt: Date }, refreshInterval: number) { + 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}.`) + } +} + +function buildTrigramSearchIndex (indexName: string, attribute: string) { + return { + name: indexName, + fields: [ Sequelize.literal('lower(immutable_unaccent(' + attribute + '))') as any ], + using: 'gin', + operator: 'gin_trgm_ops' } +} + +function createSimilarityAttribute (col: string, value: string) { + return Sequelize.fn( + 'similarity', + + searchTrigramNormalizeCol(col), + + searchTrigramNormalizeValue(value) + ) +} + +function buildBlockedAccountSQL (serverAccountId: number, userAccountId?: number) { + const blockerIds = [ serverAccountId ] + if (userAccountId) blockerIds.push(userAccountId) + + const blockerIdsString = blockerIds.join(', ') + + return 'SELECT "targetAccountId" AS "id" FROM "accountBlocklist" WHERE "accountId" IN (' + blockerIdsString + ')' + + ' UNION ALL ' + + '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 + ')' +} - return [ field, direction ] +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 addMethodsToModel (model: any, classMethods: Function[], instanceMethods: Function[] = []) { - classMethods.forEach(m => model[m.name] = m) - instanceMethods.forEach(m => model.prototype[m.name] = m) +function buildWhereIdOrUUID (id: number | string) { + return validator.isInt('' + id) ? { id } : { uuid: id } } -function getSortOnModel (model: any, value: string) { - let sort = getSort(value) +function parseAggregateResult (result: any) { + if (!result) return 0 + + const total = parseInt(result + '', 10) + if (isNaN(total)) return 0 - if (model) return [ { model: model }, sort[0], sort[1] ] - return sort + return total +} + +const createSafeIn = (model: typeof Model, stringArr: (string | number)[]) => { + return stringArr.map(t => model.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)' + ) } // --------------------------------------------------------------------------- export { - addMethodsToModel, + buildBlockedAccountSQL, + buildLocalActorIdsIn, + SortType, + buildLocalAccountIdsIn, getSort, - getSortOnModel + getVideoSort, + getBlacklistSort, + createSimilarityAttribute, + throwIfNotValid, + buildServerIdsFollowedBy, + buildTrigramSearchIndex, + buildWhereIdOrUUID, + isOutdated, + parseAggregateResult, + createSafeIn +} + +// --------------------------------------------------------------------------- + +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))) +} + +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 } }