PeerTube/server/models/utils.ts

103 lines
2.7 KiB
TypeScript
Raw Normal View History

2018-07-19 16:17:54 +02:00
import { Sequelize } from 'sequelize-typescript'
2018-08-14 15:28:30 +02:00
type SortType = { sortModel: any, sortValue: string }
2018-08-31 17:18:13 +02:00
// Translate for example "-name" to [ [ 'name', 'DESC' ], [ 'id', 'ASC' ] ]
2018-02-19 09:41:03 +01:00
function getSort (value: string, lastSort: string[] = [ 'id', 'ASC' ]) {
2018-08-31 17:32:35 +02:00
let { direction, field } = buildDirectionAndField(value)
if (field.toLowerCase() === 'match') { // Search
field = Sequelize.col('similarity')
}
2016-08-16 22:31:45 +02:00
2018-08-31 17:18:13 +02:00
return [ [ field, direction ], lastSort ]
}
function getVideoSort (value: string, lastSort: string[] = [ 'id', 'ASC' ]) {
let { direction, field } = buildDirectionAndField(value)
2016-08-16 22:31:45 +02:00
2018-07-19 16:17:54 +02:00
// Alias
2018-08-31 17:32:35 +02:00
if (field.toLowerCase() === 'match') { // Search
field = Sequelize.col('similarity')
} else if (field.toLowerCase() === 'trending') { // Sort by aggregation
2018-08-31 17:18:13 +02:00
return [
[ Sequelize.fn('COALESCE', Sequelize.fn('SUM', Sequelize.col('VideoViews.views')), '0'), direction ],
[ Sequelize.col('VideoModel.views'), direction ],
lastSort
]
}
2018-02-19 09:41:03 +01:00
return [ [ field, direction ], lastSort ]
2016-08-16 22:31:45 +02:00
}
2018-02-19 09:41:03 +01:00
function getSortOnModel (model: any, value: string, lastSort: string[] = [ 'id', 'ASC' ]) {
let [ firstSort ] = getSort(value)
Handle blacklist (#84) * Client: Add list blacklist feature * Server: Add list blacklist feature * Client: Add videoId column * Server: Add some video infos in the REST api * Client: Add video information in the blacklist list * Fix sortable columns :) * Client: Add removeFromBlacklist feature * Server: Add removeFromBlacklist feature * Move to TypeScript * Move to TypeScript and Promises * Server: Fix blacklist list sort * Server: Fetch videos informations * Use common shared interface for client and server * Add check-params remove blacklisted video tests * Add check-params list blacklisted videos tests * Add list blacklist tests * Add remove from blacklist tests * Add video blacklist management tests * Fix rebase onto develop issues * Server: Add sort on blacklist id column * Server: Add blacklists library * Add blacklist id sort test * Add check-params tests for blacklist list pagination, count and sort * Fix coding style * Increase Remote API tests timeout * Increase Request scheduler API tests timeout * Fix typo * Increase video transcoding API tests timeout * Move tests to Typescript * Use lodash orderBy method * Fix typos * Client: Remove optional tests in blacklist model attributes * Move blacklist routes from 'blacklists' to 'blacklist' * CLient: Remove blacklist-list.component.scss * Rename 'blacklists' files to 'blacklist' * Use only BlacklistedVideo interface * Server: Use getFormattedObjects method in listBlacklist method * Client: Use new coding style * Server: Use new sort validator methods * Server: Use new checkParams methods * Client: Fix sortable columns
2017-09-22 09:13:43 +02:00
2018-02-19 09:41:03 +01:00
if (model) return [ [ model, firstSort[0], firstSort[1] ], lastSort ]
return [ firstSort, lastSort ]
Handle blacklist (#84) * Client: Add list blacklist feature * Server: Add list blacklist feature * Client: Add videoId column * Server: Add some video infos in the REST api * Client: Add video information in the blacklist list * Fix sortable columns :) * Client: Add removeFromBlacklist feature * Server: Add removeFromBlacklist feature * Move to TypeScript * Move to TypeScript and Promises * Server: Fix blacklist list sort * Server: Fetch videos informations * Use common shared interface for client and server * Add check-params remove blacklisted video tests * Add check-params list blacklisted videos tests * Add list blacklist tests * Add remove from blacklist tests * Add video blacklist management tests * Fix rebase onto develop issues * Server: Add sort on blacklist id column * Server: Add blacklists library * Add blacklist id sort test * Add check-params tests for blacklist list pagination, count and sort * Fix coding style * Increase Remote API tests timeout * Increase Request scheduler API tests timeout * Fix typo * Increase video transcoding API tests timeout * Move tests to Typescript * Use lodash orderBy method * Fix typos * Client: Remove optional tests in blacklist model attributes * Move blacklist routes from 'blacklists' to 'blacklist' * CLient: Remove blacklist-list.component.scss * Rename 'blacklists' files to 'blacklist' * Use only BlacklistedVideo interface * Server: Use getFormattedObjects method in listBlacklist method * Client: Use new coding style * Server: Use new sort validator methods * Server: Use new checkParams methods * Client: Fix sortable columns
2017-09-22 09:13:43 +02:00
}
2017-12-12 17:53:50 +01:00
function throwIfNotValid (value: any, validator: (value: any) => boolean, fieldName = 'value') {
if (validator(value) === false) {
throw new Error(`"${value}" is not a valid ${fieldName}.`)
}
}
2018-07-19 16:17:54 +02:00
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)
)
}
2016-08-16 22:31:45 +02:00
// ---------------------------------------------------------------------------
2017-05-15 22:22:03 +02:00
export {
2018-08-14 15:28:30 +02:00
SortType,
Handle blacklist (#84) * Client: Add list blacklist feature * Server: Add list blacklist feature * Client: Add videoId column * Server: Add some video infos in the REST api * Client: Add video information in the blacklist list * Fix sortable columns :) * Client: Add removeFromBlacklist feature * Server: Add removeFromBlacklist feature * Move to TypeScript * Move to TypeScript and Promises * Server: Fix blacklist list sort * Server: Fetch videos informations * Use common shared interface for client and server * Add check-params remove blacklisted video tests * Add check-params list blacklisted videos tests * Add list blacklist tests * Add remove from blacklist tests * Add video blacklist management tests * Fix rebase onto develop issues * Server: Add sort on blacklist id column * Server: Add blacklists library * Add blacklist id sort test * Add check-params tests for blacklist list pagination, count and sort * Fix coding style * Increase Remote API tests timeout * Increase Request scheduler API tests timeout * Fix typo * Increase video transcoding API tests timeout * Move tests to Typescript * Use lodash orderBy method * Fix typos * Client: Remove optional tests in blacklist model attributes * Move blacklist routes from 'blacklists' to 'blacklist' * CLient: Remove blacklist-list.component.scss * Rename 'blacklists' files to 'blacklist' * Use only BlacklistedVideo interface * Server: Use getFormattedObjects method in listBlacklist method * Client: Use new coding style * Server: Use new sort validator methods * Server: Use new checkParams methods * Client: Fix sortable columns
2017-09-22 09:13:43 +02:00
getSort,
2018-08-31 17:18:13 +02:00
getVideoSort,
2017-12-12 17:53:50 +01:00
getSortOnModel,
2018-07-19 16:17:54 +02:00
createSimilarityAttribute,
throwIfNotValid,
2018-07-27 15:20:10 +02:00
buildTrigramSearchIndex
2018-07-19 16:17:54 +02:00
}
// ---------------------------------------------------------------------------
function searchTrigramNormalizeValue (value: string) {
2018-07-26 10:45:10 +02:00
return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', value))
2018-07-19 16:17:54 +02:00
}
function searchTrigramNormalizeCol (col: string) {
return Sequelize.fn('lower', Sequelize.fn('immutable_unaccent', Sequelize.col(col)))
2017-05-15 22:22:03 +02:00
}
2018-08-31 17:18:13 +02:00
function buildDirectionAndField (value: string) {
let field: any
let direction: 'ASC' | 'DESC'
if (value.substring(0, 1) === '-') {
direction = 'DESC'
field = value.substring(1)
} else {
direction = 'ASC'
field = value
}
return { direction, field }
}