X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Fmodels%2Futils.ts;h=fe4596d31b5ff5818033a5ce8a2448ce0eed3748;hb=fc8aabd0bf38441c0591f21b9b435b52e99ffc23;hp=49d32c24f95c11c4c9e3bbdba1cef372c68e9e7c;hpb=57c36b277e68b764dd34cb2e449f6e2ca3d1e9b6;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/models/utils.ts b/server/models/utils.ts index 49d32c24f..fe4596d31 100644 --- a/server/models/utils.ts +++ b/server/models/utils.ts @@ -1,32 +1,117 @@ +import { Model, Sequelize } from 'sequelize-typescript' +import validator from 'validator' +import { Col } from 'sequelize/types/lib/utils' +import { literal, OrderItem, Op } from 'sequelize' + +type Primitive = string | Function | number | boolean | Symbol | undefined | null +type DeepOmitHelper = { + [P in K]: // extra level of indirection needed to trigger homomorhic behavior + T[P] extends infer TP // distribute over unions + ? TP extends Primitive + ? TP // leave primitives and functions alone + : TP extends any[] + ? DeepOmitArray // Array special handling + : DeepOmit + : never +} +type DeepOmit = T extends Primitive ? T : DeepOmitHelper> + +type DeepOmitArray = { + [P in keyof T]: DeepOmit +} + +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 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 + ] + } + + let finalField: string | Col + // Alias - if (field.toLowerCase() === 'bestmatch') field = Sequelize.col('similarity') + 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 [ [ field, direction ], lastSort ] + 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 any[] // FIXME: typings 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) { + 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}.`) } @@ -51,32 +136,164 @@ 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 (serverAccountId: number, userAccountId?: number) { + const blockerIds = [ serverAccountId ] + if (userAccountId) blockerIds.push(userAccountId) - Sequelize.where(searchTrigramNormalizeCol(col), ' LIKE ', searchTrigramNormalizeValue(`%${value}%`)) - ] + 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 + ')' +} + +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 +} + +const createSafeIn = (model: typeof Model, stringArr: (string | number)[]) => { + return stringArr.map(t => { + return t === null + ? null + : 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)' + ) +} + +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, targetField) { + if (sourceField) { + return { + [targetField]: { + [Op.iLike]: `%${sourceField}%` + } + } + } else { + return {} + } +} + +interface QueryStringFilterPrefixes { + [key: string]: string | { prefix: string, handler: Function, multiple?: boolean } +} + +function parseQueryStringFilter (q: string, prefixes: QueryStringFilterPrefixes): { + search: string + [key: string]: string | number | string[] | number[] +} { + const tokens = q // tokenize only if we have a querystring + ? [].concat.apply([], q.split('"').map((v, i) => i % 2 ? v : v.split(' '))).filter(Boolean) // split by space unless using double quotes + : [] + + const objectMap = (obj, fn) => Object.fromEntries( + Object.entries(obj).map( + ([ k, v ], i) => [ k, fn(v, k, i) ] + ) + ) + + return { + // search is the querystring minus defined filters + search: tokens.filter(e => !Object.values(prefixes).some(p => { + if (typeof p === 'string') { + return e.startsWith(p) + } else { + return e.startsWith(p.prefix) + } + })).join(' '), + // filters defined in prefixes are added under their own name + ...objectMap(prefixes, p => { + if (typeof p === 'string') { + return tokens.filter(e => e.startsWith(p)).map(e => e.slice(p.length)) // we keep the matched item, and remove its prefix + } else { + const _tokens = tokens.filter(e => e.startsWith(p.prefix)).map(e => e.slice(p.prefix.length)).map(p.handler) + // multiple is false by default, meaning we usually just keep the first occurence of a given prefix + if (!p.multiple && _tokens.length > 0) { + return _tokens[0] + } else if (!p.multiple) { + return '' + } + return _tokens + } + }) } } // --------------------------------------------------------------------------- export { + DeepOmit, + buildBlockedAccountSQL, + buildLocalActorIdsIn, + SortType, + buildLocalAccountIdsIn, getSort, - getSortOnModel, + getCommentSort, + getVideoSort, + getBlacklistSort, createSimilarityAttribute, throwIfNotValid, + buildServerIdsFollowedBy, buildTrigramSearchIndex, - createSearchTrigramQuery + buildWhereIdOrUUID, + isOutdated, + parseAggregateResult, + getFollowsSort, + buildDirectionAndField, + createSafeIn, + searchAttribute, + parseQueryStringFilter } // --------------------------------------------------------------------------- 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) {