diff options
author | Chocobozzz <me@florianbigard.com> | 2021-07-21 15:51:30 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2021-07-21 15:51:30 +0200 |
commit | a24bd1ed41b43790bab6ba789580bb4e85f07d85 (patch) | |
tree | a54b0f6c921ba83a6e909cd0ced325b2d4b8863c /shared/extra-utils/moderation | |
parent | 5f26f13b3c16ac5ae0a3b0a7142d84a9528cf565 (diff) | |
parent | c63830f15403ac4e750829f27d8bbbdc9a59282c (diff) | |
download | PeerTube-a24bd1ed41b43790bab6ba789580bb4e85f07d85.tar.gz PeerTube-a24bd1ed41b43790bab6ba789580bb4e85f07d85.tar.zst PeerTube-a24bd1ed41b43790bab6ba789580bb4e85f07d85.zip |
Merge branch 'next' into develop
Diffstat (limited to 'shared/extra-utils/moderation')
-rw-r--r-- | shared/extra-utils/moderation/abuses-command.ts | 228 | ||||
-rw-r--r-- | shared/extra-utils/moderation/abuses.ts | 244 | ||||
-rw-r--r-- | shared/extra-utils/moderation/index.ts | 1 |
3 files changed, 229 insertions, 244 deletions
diff --git a/shared/extra-utils/moderation/abuses-command.ts b/shared/extra-utils/moderation/abuses-command.ts new file mode 100644 index 000000000..7b3abb056 --- /dev/null +++ b/shared/extra-utils/moderation/abuses-command.ts | |||
@@ -0,0 +1,228 @@ | |||
1 | import { pick } from 'lodash' | ||
2 | import { | ||
3 | AbuseFilter, | ||
4 | AbuseMessage, | ||
5 | AbusePredefinedReasonsString, | ||
6 | AbuseState, | ||
7 | AbuseUpdate, | ||
8 | AbuseVideoIs, | ||
9 | AdminAbuse, | ||
10 | HttpStatusCode, | ||
11 | ResultList, | ||
12 | UserAbuse | ||
13 | } from '@shared/models' | ||
14 | import { unwrapBody } from '../requests/requests' | ||
15 | import { AbstractCommand, OverrideCommandOptions } from '../shared' | ||
16 | |||
17 | export class AbusesCommand extends AbstractCommand { | ||
18 | |||
19 | report (options: OverrideCommandOptions & { | ||
20 | reason: string | ||
21 | |||
22 | accountId?: number | ||
23 | videoId?: number | ||
24 | commentId?: number | ||
25 | |||
26 | predefinedReasons?: AbusePredefinedReasonsString[] | ||
27 | |||
28 | startAt?: number | ||
29 | endAt?: number | ||
30 | }) { | ||
31 | const path = '/api/v1/abuses' | ||
32 | |||
33 | const video = options.videoId | ||
34 | ? { | ||
35 | id: options.videoId, | ||
36 | startAt: options.startAt, | ||
37 | endAt: options.endAt | ||
38 | } | ||
39 | : undefined | ||
40 | |||
41 | const comment = options.commentId | ||
42 | ? { id: options.commentId } | ||
43 | : undefined | ||
44 | |||
45 | const account = options.accountId | ||
46 | ? { id: options.accountId } | ||
47 | : undefined | ||
48 | |||
49 | const body = { | ||
50 | account, | ||
51 | video, | ||
52 | comment, | ||
53 | |||
54 | reason: options.reason, | ||
55 | predefinedReasons: options.predefinedReasons | ||
56 | } | ||
57 | |||
58 | return unwrapBody<{ abuse: { id: number } }>(this.postBodyRequest({ | ||
59 | ...options, | ||
60 | |||
61 | path, | ||
62 | fields: body, | ||
63 | implicitToken: true, | ||
64 | defaultExpectedStatus: HttpStatusCode.OK_200 | ||
65 | })) | ||
66 | } | ||
67 | |||
68 | getAdminList (options: OverrideCommandOptions & { | ||
69 | start?: number | ||
70 | count?: number | ||
71 | sort?: string | ||
72 | |||
73 | id?: number | ||
74 | predefinedReason?: AbusePredefinedReasonsString | ||
75 | search?: string | ||
76 | filter?: AbuseFilter | ||
77 | state?: AbuseState | ||
78 | videoIs?: AbuseVideoIs | ||
79 | searchReporter?: string | ||
80 | searchReportee?: string | ||
81 | searchVideo?: string | ||
82 | searchVideoChannel?: string | ||
83 | } = {}) { | ||
84 | const toPick = [ | ||
85 | 'count', | ||
86 | 'filter', | ||
87 | 'id', | ||
88 | 'predefinedReason', | ||
89 | 'search', | ||
90 | 'searchReportee', | ||
91 | 'searchReporter', | ||
92 | 'searchVideo', | ||
93 | 'searchVideoChannel', | ||
94 | 'sort', | ||
95 | 'start', | ||
96 | 'state', | ||
97 | 'videoIs' | ||
98 | ] | ||
99 | |||
100 | const path = '/api/v1/abuses' | ||
101 | |||
102 | const defaultQuery = { sort: 'createdAt' } | ||
103 | const query = { ...defaultQuery, ...pick(options, toPick) } | ||
104 | |||
105 | return this.getRequestBody<ResultList<AdminAbuse>>({ | ||
106 | ...options, | ||
107 | |||
108 | path, | ||
109 | query, | ||
110 | implicitToken: true, | ||
111 | defaultExpectedStatus: HttpStatusCode.OK_200 | ||
112 | }) | ||
113 | } | ||
114 | |||
115 | getUserList (options: OverrideCommandOptions & { | ||
116 | start?: number | ||
117 | count?: number | ||
118 | sort?: string | ||
119 | |||
120 | id?: number | ||
121 | search?: string | ||
122 | state?: AbuseState | ||
123 | }) { | ||
124 | const toPick = [ | ||
125 | 'id', | ||
126 | 'search', | ||
127 | 'state', | ||
128 | 'start', | ||
129 | 'count', | ||
130 | 'sort' | ||
131 | ] | ||
132 | |||
133 | const path = '/api/v1/users/me/abuses' | ||
134 | |||
135 | const defaultQuery = { sort: 'createdAt' } | ||
136 | const query = { ...defaultQuery, ...pick(options, toPick) } | ||
137 | |||
138 | return this.getRequestBody<ResultList<UserAbuse>>({ | ||
139 | ...options, | ||
140 | |||
141 | path, | ||
142 | query, | ||
143 | implicitToken: true, | ||
144 | defaultExpectedStatus: HttpStatusCode.OK_200 | ||
145 | }) | ||
146 | } | ||
147 | |||
148 | update (options: OverrideCommandOptions & { | ||
149 | abuseId: number | ||
150 | body: AbuseUpdate | ||
151 | }) { | ||
152 | const { abuseId, body } = options | ||
153 | const path = '/api/v1/abuses/' + abuseId | ||
154 | |||
155 | return this.putBodyRequest({ | ||
156 | ...options, | ||
157 | |||
158 | path, | ||
159 | fields: body, | ||
160 | implicitToken: true, | ||
161 | defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204 | ||
162 | }) | ||
163 | } | ||
164 | |||
165 | delete (options: OverrideCommandOptions & { | ||
166 | abuseId: number | ||
167 | }) { | ||
168 | const { abuseId } = options | ||
169 | const path = '/api/v1/abuses/' + abuseId | ||
170 | |||
171 | return this.deleteRequest({ | ||
172 | ...options, | ||
173 | |||
174 | path, | ||
175 | implicitToken: true, | ||
176 | defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204 | ||
177 | }) | ||
178 | } | ||
179 | |||
180 | listMessages (options: OverrideCommandOptions & { | ||
181 | abuseId: number | ||
182 | }) { | ||
183 | const { abuseId } = options | ||
184 | const path = '/api/v1/abuses/' + abuseId + '/messages' | ||
185 | |||
186 | return this.getRequestBody<ResultList<AbuseMessage>>({ | ||
187 | ...options, | ||
188 | |||
189 | path, | ||
190 | implicitToken: true, | ||
191 | defaultExpectedStatus: HttpStatusCode.OK_200 | ||
192 | }) | ||
193 | } | ||
194 | |||
195 | deleteMessage (options: OverrideCommandOptions & { | ||
196 | abuseId: number | ||
197 | messageId: number | ||
198 | }) { | ||
199 | const { abuseId, messageId } = options | ||
200 | const path = '/api/v1/abuses/' + abuseId + '/messages/' + messageId | ||
201 | |||
202 | return this.deleteRequest({ | ||
203 | ...options, | ||
204 | |||
205 | path, | ||
206 | implicitToken: true, | ||
207 | defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204 | ||
208 | }) | ||
209 | } | ||
210 | |||
211 | addMessage (options: OverrideCommandOptions & { | ||
212 | abuseId: number | ||
213 | message: string | ||
214 | }) { | ||
215 | const { abuseId, message } = options | ||
216 | const path = '/api/v1/abuses/' + abuseId + '/messages' | ||
217 | |||
218 | return this.postBodyRequest({ | ||
219 | ...options, | ||
220 | |||
221 | path, | ||
222 | fields: { message }, | ||
223 | implicitToken: true, | ||
224 | defaultExpectedStatus: HttpStatusCode.OK_200 | ||
225 | }) | ||
226 | } | ||
227 | |||
228 | } | ||
diff --git a/shared/extra-utils/moderation/abuses.ts b/shared/extra-utils/moderation/abuses.ts deleted file mode 100644 index c0fda722f..000000000 --- a/shared/extra-utils/moderation/abuses.ts +++ /dev/null | |||
@@ -1,244 +0,0 @@ | |||
1 | import { AbuseFilter, AbusePredefinedReasonsString, AbuseState, AbuseUpdate, AbuseVideoIs } from '@shared/models' | ||
2 | import { makeDeleteRequest, makeGetRequest, makePostBodyRequest, makePutBodyRequest } from '../requests/requests' | ||
3 | import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes' | ||
4 | |||
5 | function reportAbuse (options: { | ||
6 | url: string | ||
7 | token: string | ||
8 | |||
9 | reason: string | ||
10 | |||
11 | accountId?: number | ||
12 | videoId?: number | ||
13 | commentId?: number | ||
14 | |||
15 | predefinedReasons?: AbusePredefinedReasonsString[] | ||
16 | |||
17 | startAt?: number | ||
18 | endAt?: number | ||
19 | |||
20 | statusCodeExpected?: number | ||
21 | }) { | ||
22 | const path = '/api/v1/abuses' | ||
23 | |||
24 | const video = options.videoId | ||
25 | ? { | ||
26 | id: options.videoId, | ||
27 | startAt: options.startAt, | ||
28 | endAt: options.endAt | ||
29 | } | ||
30 | : undefined | ||
31 | |||
32 | const comment = options.commentId | ||
33 | ? { id: options.commentId } | ||
34 | : undefined | ||
35 | |||
36 | const account = options.accountId | ||
37 | ? { id: options.accountId } | ||
38 | : undefined | ||
39 | |||
40 | const body = { | ||
41 | account, | ||
42 | video, | ||
43 | comment, | ||
44 | |||
45 | reason: options.reason, | ||
46 | predefinedReasons: options.predefinedReasons | ||
47 | } | ||
48 | |||
49 | return makePostBodyRequest({ | ||
50 | url: options.url, | ||
51 | path, | ||
52 | token: options.token, | ||
53 | |||
54 | fields: body, | ||
55 | statusCodeExpected: options.statusCodeExpected || HttpStatusCode.OK_200 | ||
56 | }) | ||
57 | } | ||
58 | |||
59 | function getAdminAbusesList (options: { | ||
60 | url: string | ||
61 | token: string | ||
62 | |||
63 | start?: number | ||
64 | count?: number | ||
65 | sort?: string | ||
66 | |||
67 | id?: number | ||
68 | predefinedReason?: AbusePredefinedReasonsString | ||
69 | search?: string | ||
70 | filter?: AbuseFilter | ||
71 | state?: AbuseState | ||
72 | videoIs?: AbuseVideoIs | ||
73 | searchReporter?: string | ||
74 | searchReportee?: string | ||
75 | searchVideo?: string | ||
76 | searchVideoChannel?: string | ||
77 | }) { | ||
78 | const { | ||
79 | url, | ||
80 | token, | ||
81 | start, | ||
82 | count, | ||
83 | sort, | ||
84 | id, | ||
85 | predefinedReason, | ||
86 | search, | ||
87 | filter, | ||
88 | state, | ||
89 | videoIs, | ||
90 | searchReporter, | ||
91 | searchReportee, | ||
92 | searchVideo, | ||
93 | searchVideoChannel | ||
94 | } = options | ||
95 | const path = '/api/v1/abuses' | ||
96 | |||
97 | const query = { | ||
98 | id, | ||
99 | predefinedReason, | ||
100 | search, | ||
101 | state, | ||
102 | filter, | ||
103 | videoIs, | ||
104 | start, | ||
105 | count, | ||
106 | sort: sort || 'createdAt', | ||
107 | searchReporter, | ||
108 | searchReportee, | ||
109 | searchVideo, | ||
110 | searchVideoChannel | ||
111 | } | ||
112 | |||
113 | return makeGetRequest({ | ||
114 | url, | ||
115 | path, | ||
116 | token, | ||
117 | query, | ||
118 | statusCodeExpected: HttpStatusCode.OK_200 | ||
119 | }) | ||
120 | } | ||
121 | |||
122 | function getUserAbusesList (options: { | ||
123 | url: string | ||
124 | token: string | ||
125 | |||
126 | start?: number | ||
127 | count?: number | ||
128 | sort?: string | ||
129 | |||
130 | id?: number | ||
131 | search?: string | ||
132 | state?: AbuseState | ||
133 | }) { | ||
134 | const { | ||
135 | url, | ||
136 | token, | ||
137 | start, | ||
138 | count, | ||
139 | sort, | ||
140 | id, | ||
141 | search, | ||
142 | state | ||
143 | } = options | ||
144 | const path = '/api/v1/users/me/abuses' | ||
145 | |||
146 | const query = { | ||
147 | id, | ||
148 | search, | ||
149 | state, | ||
150 | start, | ||
151 | count, | ||
152 | sort: sort || 'createdAt' | ||
153 | } | ||
154 | |||
155 | return makeGetRequest({ | ||
156 | url, | ||
157 | path, | ||
158 | token, | ||
159 | query, | ||
160 | statusCodeExpected: HttpStatusCode.OK_200 | ||
161 | }) | ||
162 | } | ||
163 | |||
164 | function updateAbuse ( | ||
165 | url: string, | ||
166 | token: string, | ||
167 | abuseId: number, | ||
168 | body: AbuseUpdate, | ||
169 | statusCodeExpected = HttpStatusCode.NO_CONTENT_204 | ||
170 | ) { | ||
171 | const path = '/api/v1/abuses/' + abuseId | ||
172 | |||
173 | return makePutBodyRequest({ | ||
174 | url, | ||
175 | token, | ||
176 | path, | ||
177 | fields: body, | ||
178 | statusCodeExpected | ||
179 | }) | ||
180 | } | ||
181 | |||
182 | function deleteAbuse (url: string, token: string, abuseId: number, statusCodeExpected = HttpStatusCode.NO_CONTENT_204) { | ||
183 | const path = '/api/v1/abuses/' + abuseId | ||
184 | |||
185 | return makeDeleteRequest({ | ||
186 | url, | ||
187 | token, | ||
188 | path, | ||
189 | statusCodeExpected | ||
190 | }) | ||
191 | } | ||
192 | |||
193 | function listAbuseMessages (url: string, token: string, abuseId: number, statusCodeExpected = HttpStatusCode.OK_200) { | ||
194 | const path = '/api/v1/abuses/' + abuseId + '/messages' | ||
195 | |||
196 | return makeGetRequest({ | ||
197 | url, | ||
198 | token, | ||
199 | path, | ||
200 | statusCodeExpected | ||
201 | }) | ||
202 | } | ||
203 | |||
204 | function deleteAbuseMessage ( | ||
205 | url: string, | ||
206 | token: string, | ||
207 | abuseId: number, | ||
208 | messageId: number, | ||
209 | statusCodeExpected = HttpStatusCode.NO_CONTENT_204 | ||
210 | ) { | ||
211 | const path = '/api/v1/abuses/' + abuseId + '/messages/' + messageId | ||
212 | |||
213 | return makeDeleteRequest({ | ||
214 | url, | ||
215 | token, | ||
216 | path, | ||
217 | statusCodeExpected | ||
218 | }) | ||
219 | } | ||
220 | |||
221 | function addAbuseMessage (url: string, token: string, abuseId: number, message: string, statusCodeExpected = HttpStatusCode.OK_200) { | ||
222 | const path = '/api/v1/abuses/' + abuseId + '/messages' | ||
223 | |||
224 | return makePostBodyRequest({ | ||
225 | url, | ||
226 | token, | ||
227 | path, | ||
228 | fields: { message }, | ||
229 | statusCodeExpected | ||
230 | }) | ||
231 | } | ||
232 | |||
233 | // --------------------------------------------------------------------------- | ||
234 | |||
235 | export { | ||
236 | reportAbuse, | ||
237 | getAdminAbusesList, | ||
238 | updateAbuse, | ||
239 | deleteAbuse, | ||
240 | getUserAbusesList, | ||
241 | listAbuseMessages, | ||
242 | deleteAbuseMessage, | ||
243 | addAbuseMessage | ||
244 | } | ||
diff --git a/shared/extra-utils/moderation/index.ts b/shared/extra-utils/moderation/index.ts new file mode 100644 index 000000000..b37643956 --- /dev/null +++ b/shared/extra-utils/moderation/index.ts | |||
@@ -0,0 +1 @@ | |||
export * from './abuses-command' | |||