-import { Model, Sequelize } from 'sequelize-typescript'
+import { literal, Model, ModelStatic, Op, OrderItem, Sequelize } from 'sequelize'
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<T, K extends keyof T> = {
- [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<TP, K> // Array special handling
- : DeepOmit<TP, K>
- : never
-}
-type DeepOmit<T, K> = T extends Primitive ? T : DeepOmitHelper<T, Exclude<keyof T, K>>
-
-type DeepOmitArray<T extends any[], K> = {
- [P in keyof T]: DeepOmit<T[P], K>
-}
+import { forceNumber } from '@shared/core-utils'
+import { AttributesOnly } from '@shared/typescript-utils'
type SortType = { sortModel: string, sortValue: string }
function getSort (value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] {
const { direction, field } = buildDirectionAndField(value)
- let finalField: string | Col
+ let finalField: string | ReturnType<typeof Sequelize.col>
if (field.toLowerCase() === 'match') { // Search
finalField = Sequelize.col('similarity')
- } else if (field === 'videoQuotaUsed') { // Users list
- finalField = Sequelize.col('videoQuotaUsed')
} else {
finalField = field
}
return [ [ finalField, direction ], lastSort ]
}
+function getAdminUsersSort (value: string): OrderItem[] {
+ const { direction, field } = buildDirectionAndField(value)
+
+ let finalField: string | ReturnType<typeof Sequelize.col>
+
+ 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)
[ 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<typeof Sequelize.col>
// Alias
if (field.toLowerCase() === 'match') { // Search
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 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
+ if (model) return [ [ literal(`"${model}.${firstSort[0]}" ${firstSort[1]}`) ], lastSort ] as OrderItem[]
return [ firstSort, lastSort ]
}
-function getFollowsSort (value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] {
+function getInstanceFollowsSort (value: string, lastSort: OrderItem = [ 'id', 'ASC' ]): OrderItem[] {
const { direction, field } = buildDirectionAndField(value)
if (field === 'redundancyAllowed') {
return [
- [ 'ActorFollowing', 'Server', 'redundancyAllowed', direction ],
+ [ '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()
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'
}
)
}
-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" ' +
'INNER JOIN "actor" ON actor.id = "actorFollow"."targetActorId" ' +
'WHERE "actorFollow"."actorId" = ' + actorIdNumber +
- ')'
+ ')'
}
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 => {
+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
- : model.sequelize.escape('' + t)
- }).join(', ')
+ : sequelize.escape('' + t)
+ }).concat(additionalUnescaped).join(', ')
}
function buildLocalAccountIdsIn () {
return { direction, field }
}
-function searchAttribute (sourceField, targetField) {
- if (sourceField) {
- return {
- [targetField]: {
- [Op.iLike]: `%${sourceField}%`
- }
+function searchAttribute (sourceField?: string, targetField?: string) {
+ if (!sourceField) return {}
+
+ return {
+ [targetField]: {
+ // FIXME: ts error
+ [Op.iLike as any]: `%${sourceField}%`
}
- } else {
- return {}
}
}
-interface QueryStringFilterPrefixes {
- [key: string]: string | { prefix: string, handler: Function, multiple?: boolean }
-}
+function buildSQLAttributes <M extends Model> (options: {
+ model: ModelStatic<M>
+ tableName: string
-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
- : []
-
- // TODO: when Typescript supports Object.fromEntries, replace with the Object method
- function fromEntries<T> (entries: [keyof T, T[keyof T]][]): T {
- return entries.reduce(
- (acc, [ key, value ]) => ({ ...acc, [key]: value }),
- {} as T
- )
- }
+ excludeAttributes?: Exclude<keyof AttributesOnly<M>, symbol>[]
+ aliasPrefix?: string
+}) {
+ const { model, tableName, aliasPrefix, excludeAttributes } = options
- const objectMap = (obj, fn) => fromEntries(
- Object.entries(obj).map(
- ([ k, v ], i) => [ k, fn(v, k, i) ]
- )
- )
+ const attributes = Object.keys(model.getAttributes()) as Exclude<keyof AttributesOnly<M>, symbol>[]
- 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
- }
+ 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 {
- DeepOmit,
+ buildSQLAttributes,
buildBlockedAccountSQL,
buildLocalActorIdsIn,
+ getPlaylistSort,
SortType,
buildLocalAccountIdsIn,
getSort,
getCommentSort,
+ getAdminUsersSort,
getVideoSort,
getBlacklistSort,
+ getChannelSyncSort,
createSimilarityAttribute,
throwIfNotValid,
buildServerIdsFollowedBy,
buildWhereIdOrUUID,
isOutdated,
parseAggregateResult,
- getFollowsSort,
+ getInstanceFollowsSort,
buildDirectionAndField,
createSafeIn,
searchAttribute,
- parseQueryStringFilter
+ parseRowCountResult
}
// ---------------------------------------------------------------------------
projects / github / Chocobozzz / PeerTube.git / blobdiff