]>
Commit | Line | Data |
---|---|---|
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' | |
7 | ||
8 | const debugLogger = debug('peertube:rest') | |
9 | ||
10 | interface QueryStringFilterPrefixes { | |
11 | [key: string]: { | |
12 | prefix: string | |
13 | handler?: (v: string) => string | number | boolean | |
14 | multiple?: boolean | |
15 | isBoolean?: boolean | |
16 | } | |
17 | } | |
18 | ||
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 } | |
21 | ||
22 | @Injectable() | |
23 | export class RestService { | |
24 | ||
25 | addRestGetParams (params: HttpParams, pagination?: RestPagination, sort?: SortMeta | string) { | |
26 | let newParams = params | |
27 | ||
28 | if (pagination !== undefined) { | |
29 | newParams = newParams.set('start', pagination.start.toString()) | |
30 | .set('count', pagination.count.toString()) | |
31 | } | |
32 | ||
33 | if (sort !== undefined) { | |
34 | newParams = newParams.set('sort', this.buildSortString(sort)) | |
35 | } | |
36 | ||
37 | return newParams | |
38 | } | |
39 | ||
40 | buildSortString (sort: SortMeta | string) { | |
41 | if (typeof sort === 'string') { | |
42 | return sort | |
43 | } | |
44 | ||
45 | const sortPrefix = sort.order === 1 ? '' : '-' | |
46 | return sortPrefix + sort.field | |
47 | } | |
48 | ||
49 | addArrayParams (params: HttpParams, name: string, values: (string | number)[]) { | |
50 | for (const v of values) { | |
51 | params = params.append(name, v) | |
52 | } | |
53 | ||
54 | return params | |
55 | } | |
56 | ||
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 | |
61 | ||
62 | if (Array.isArray(value)) { | |
63 | params = this.addArrayParams(params, name, value) | |
64 | } else { | |
65 | params = params.append(name, value) | |
66 | } | |
67 | } | |
68 | ||
69 | return params | |
70 | } | |
71 | ||
72 | componentToRestPagination (componentPagination: ComponentPaginationLight): RestPagination { | |
73 | const start: number = (componentPagination.currentPage - 1) * componentPagination.itemsPerPage | |
74 | const count: number = componentPagination.itemsPerPage | |
75 | ||
76 | return { start, count } | |
77 | } | |
78 | ||
79 | /* | |
80 | * Returns an object containing the filters and the remaining search | |
81 | */ | |
82 | parseQueryStringFilter <T extends QueryStringFilterPrefixes> (q: string, prefixes: T): ParseQueryStringFiltersResult<keyof T> { | |
83 | if (!q) return {} | |
84 | ||
85 | const tokens = this.tokenizeString(q) | |
86 | ||
87 | // Build prefix array | |
88 | const prefixeStrings = Object.values(prefixes) | |
89 | .map(p => p.prefix) | |
90 | ||
91 | debugLogger(`Built tokens "${tokens.join(', ')}" for prefixes "${prefixeStrings.join(', ')}"`) | |
92 | ||
93 | // Search is the querystring minus defined filters | |
94 | const searchTokens = tokens.filter(t => { | |
95 | return prefixeStrings.every(prefixString => t.startsWith(prefixString) === false) | |
96 | }) | |
97 | ||
98 | const additionalFilters: ParseQueryStringFilters<keyof T> = {} | |
99 | ||
100 | for (const prefixKey of Object.keys(prefixes) as (keyof T)[]) { | |
101 | const prefixObj = prefixes[prefixKey] | |
102 | const prefix = prefixObj.prefix | |
103 | ||
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 "" | |
107 | .map(t => { | |
108 | if (prefixObj.handler) return prefixObj.handler(t) | |
109 | ||
110 | if (prefixObj.isBoolean) { | |
111 | if (t === 'true') return true | |
112 | if (t === 'false') return false | |
113 | ||
114 | return undefined | |
115 | } | |
116 | ||
117 | return t | |
118 | }) | |
119 | .filter(t => t !== null && t !== undefined) | |
120 | ||
121 | if (matchedTokens.length === 0) continue | |
122 | ||
123 | additionalFilters[prefixKey] = prefixObj.multiple === true | |
124 | ? matchedTokens | |
125 | : matchedTokens[0] | |
126 | } | |
127 | ||
128 | const search = searchTokens.join(' ') || undefined | |
129 | ||
130 | debugLogger('Built search: ' + search, additionalFilters) | |
131 | ||
132 | return { | |
133 | search, | |
134 | ||
135 | ...additionalFilters | |
136 | } | |
137 | } | |
138 | ||
139 | tokenizeString (q: string) { | |
140 | if (!q) return [] | |
141 | ||
142 | // Tokenize the strings using spaces that are not in quotes | |
143 | return q.match(/(?:[^\s"]+|"[^"]*")+/g) | |
144 | .filter(token => !!token) | |
145 | } | |
146 | } |