1 import * as debug from 'debug'
2 import { SortMeta } from 'primeng/api'
3 import { HttpParams } from '@angular/common/http'
4 import { Injectable } from '@angular/core'
5 import { ComponentPaginationLight } from './component-pagination.model'
6 import { RestPagination } from './rest-pagination'
8 const logger = debug('peertube:rest')
10 interface QueryStringFilterPrefixes {
13 handler?: (v: string) => string | number | boolean
19 type ParseQueryStringFilters <K extends keyof any> = Partial<Record<K, string | number | boolean | (string | number | boolean)[]>>
20 type ParseQueryStringFiltersResult <K extends keyof any> = ParseQueryStringFilters<K> & { search?: string }
23 export class RestService {
25 addRestGetParams (params: HttpParams, pagination?: RestPagination, sort?: SortMeta | string) {
26 let newParams = params
28 if (pagination !== undefined) {
29 newParams = newParams.set('start', pagination.start.toString())
30 .set('count', pagination.count.toString())
33 if (sort !== undefined) {
36 if (typeof sort === 'string') {
39 const sortPrefix = sort.order === 1 ? '' : '-'
40 sortString = sortPrefix + sort.field
43 newParams = newParams.set('sort', sortString)
49 addArrayParams (params: HttpParams, name: string, values: (string | number)[]) {
50 for (const v of values) {
51 params = params.append(name, v)
57 addObjectParams (params: HttpParams, object: { [ name: string ]: any }) {
58 for (const name of Object.keys(object)) {
59 const value = object[name]
60 if (value === undefined || value === null) continue
62 if (Array.isArray(value)) {
63 params = this.addArrayParams(params, name, value)
65 params = params.append(name, value)
72 componentToRestPagination (componentPagination: ComponentPaginationLight): RestPagination {
73 const start: number = (componentPagination.currentPage - 1) * componentPagination.itemsPerPage
74 const count: number = componentPagination.itemsPerPage
76 return { start, count }
80 * Returns an object containing the filters and the remaining search
82 parseQueryStringFilter <T extends QueryStringFilterPrefixes> (q: string, prefixes: T): ParseQueryStringFiltersResult<keyof T> {
85 const tokens = this.tokenizeString(q)
88 const prefixeStrings = Object.values(prefixes)
91 logger(`Built tokens "${tokens.join(', ')}" for prefixes "${prefixeStrings.join(', ')}"`)
93 // Search is the querystring minus defined filters
94 const searchTokens = tokens.filter(t => {
95 return prefixeStrings.every(prefixString => t.startsWith(prefixString) === false)
98 const additionalFilters: ParseQueryStringFilters<keyof T> = {}
100 for (const prefixKey of Object.keys(prefixes) as (keyof T)[]) {
101 const prefixObj = prefixes[prefixKey]
102 const prefix = prefixObj.prefix
104 const matchedTokens = tokens.filter(t => t.startsWith(prefix))
105 .map(t => t.slice(prefix.length)) // Keep the value filter
106 .map(t => t.replace(/^"|"$/g, '')) // Remove ""
108 if (prefixObj.handler) return prefixObj.handler(t)
110 if (prefixObj.isBoolean) {
111 if (t === 'true') return true
112 if (t === 'false') return false
119 .filter(t => t !== null && t !== undefined)
121 if (matchedTokens.length === 0) continue
123 additionalFilters[prefixKey] = prefixObj.multiple === true
128 const search = searchTokens.join(' ') || undefined
130 logger('Built search: ' + search, additionalFilters)
139 tokenizeString (q: string) {
142 // Tokenize the strings using spaces that are not in quotes
143 return q.match(/(?:[^\s"]+|"[^"]*")+/g)
144 .filter(token => !!token)