]>
Commit | Line | Data |
---|---|---|
4d4e5cd4 | 1 | import * as config from 'config' |
65fcc311 | 2 | import { join } from 'path' |
3fd3ab2d | 3 | import { JobCategory, JobState, VideoRateType } from '../../shared/models' |
50d6de9c | 4 | import { ActivityPubActorType } from '../../shared/models/activitypub' |
225a89c2 | 5 | import { FollowState } from '../../shared/models/actors' |
3fd3ab2d | 6 | import { VideoPrivacy } from '../../shared/models/videos' |
e02643f3 | 7 | // Do not use barrels, remain constants as independent as possible |
225a89c2 | 8 | import { isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils' |
ee9e7b61 | 9 | |
9f6bae3a C |
10 | // --------------------------------------------------------------------------- |
11 | ||
60650c77 | 12 | const LAST_MIGRATION_VERSION = 170 |
5804c0db C |
13 | |
14 | // --------------------------------------------------------------------------- | |
15 | ||
9f6bae3a | 16 | // API version |
f0f5567b | 17 | const API_VERSION = 'v1' |
9f10b292 | 18 | |
9f6bae3a C |
19 | // Number of results by default for the pagination |
20 | const PAGINATION_COUNT_DEFAULT = 15 | |
21 | ||
9f6bae3a C |
22 | // Sortable columns per schema |
23 | const SORTABLE_COLUMNS = { | |
9c2c18f3 | 24 | USERS: [ 'id', 'username', 'createdAt' ], |
265ba139 | 25 | ACCOUNTS: [ 'createdAt' ], |
5cd80545 | 26 | JOBS: [ 'id', 'createdAt' ], |
9c2c18f3 | 27 | VIDEO_ABUSES: [ 'id', 'createdAt' ], |
72c7248b | 28 | VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ], |
792dbaf0 | 29 | VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ], |
bf1f6508 | 30 | VIDEO_COMMENT_THREADS: [ 'createdAt' ], |
7a7724e6 C |
31 | BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ], |
32 | FOLLOWERS: [ 'createdAt' ], | |
33 | FOLLOWING: [ 'createdAt' ] | |
9f6bae3a | 34 | } |
9f10b292 | 35 | |
2f372a86 C |
36 | const OAUTH_LIFETIME = { |
37 | ACCESS_TOKEN: 3600 * 4, // 4 hours | |
38 | REFRESH_TOKEN: 1209600 // 2 weeks | |
39 | } | |
40 | ||
9f6bae3a | 41 | // --------------------------------------------------------------------------- |
26d7d31b | 42 | |
60650c77 C |
43 | // Number of points we add/remove after a successful/bad request |
44 | const ACTOR_FOLLOW_SCORE = { | |
225a89c2 C |
45 | PENALTY: -10, |
46 | BONUS: 10, | |
60650c77 C |
47 | BASE: 1000, |
48 | MAX: 10000 | |
225a89c2 C |
49 | } |
50 | ||
51 | const FOLLOW_STATES: { [ id: string ]: FollowState } = { | |
52 | PENDING: 'pending', | |
53 | ACCEPTED: 'accepted' | |
54 | } | |
55 | ||
56 | const REMOTE_SCHEME = { | |
57 | HTTP: 'https', | |
58 | WS: 'wss' | |
59 | } | |
60 | ||
61 | const JOB_STATES: { [ id: string ]: JobState } = { | |
62 | PENDING: 'pending', | |
63 | PROCESSING: 'processing', | |
64 | ERROR: 'error', | |
65 | SUCCESS: 'success' | |
66 | } | |
67 | const JOB_CATEGORIES: { [ id: string ]: JobCategory } = { | |
68 | TRANSCODING: 'transcoding', | |
69 | ACTIVITYPUB_HTTP: 'activitypub-http' | |
70 | } | |
71 | // How many maximum jobs we fetch from the database per cycle | |
72 | const JOBS_FETCH_LIMIT_PER_CYCLE = { | |
73 | transcoding: 10, | |
74 | httpRequest: 20 | |
75 | } | |
76 | // 1 minutes | |
77 | let JOBS_FETCHING_INTERVAL = 60000 | |
78 | ||
60650c77 C |
79 | // 1 hour |
80 | let SCHEDULER_INTERVAL = 60000 * 60 | |
81 | ||
225a89c2 C |
82 | // --------------------------------------------------------------------------- |
83 | ||
e861452f | 84 | const CONFIG = { |
d16b5172 | 85 | LISTEN: { |
65fcc311 | 86 | PORT: config.get<number>('listen.port') |
d16b5172 | 87 | }, |
e861452f | 88 | DATABASE: { |
65fcc311 C |
89 | DBNAME: 'peertube' + config.get<string>('database.suffix'), |
90 | HOSTNAME: config.get<string>('database.hostname'), | |
91 | PORT: config.get<number>('database.port'), | |
92 | USERNAME: config.get<string>('database.username'), | |
93 | PASSWORD: config.get<string>('database.password') | |
e861452f | 94 | }, |
e861452f | 95 | STORAGE: { |
2295ce6c | 96 | AVATARS_DIR: join(root(), config.get<string>('storage.avatars')), |
e02643f3 C |
97 | LOG_DIR: join(root(), config.get<string>('storage.logs')), |
98 | VIDEOS_DIR: join(root(), config.get<string>('storage.videos')), | |
99 | THUMBNAILS_DIR: join(root(), config.get<string>('storage.thumbnails')), | |
100 | PREVIEWS_DIR: join(root(), config.get<string>('storage.previews')), | |
f981dae8 C |
101 | TORRENTS_DIR: join(root(), config.get<string>('storage.torrents')), |
102 | CACHE_DIR: join(root(), config.get<string>('storage.cache')) | |
e861452f C |
103 | }, |
104 | WEBSERVER: { | |
65fcc311 C |
105 | SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http', |
106 | WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws', | |
107 | HOSTNAME: config.get<string>('webserver.hostname'), | |
108 | PORT: config.get<number>('webserver.port'), | |
109 | URL: '', | |
110 | HOST: '' | |
4793c343 C |
111 | }, |
112 | ADMIN: { | |
65fcc311 | 113 | EMAIL: config.get<string>('admin.email') |
e22528ac C |
114 | }, |
115 | SIGNUP: { | |
291e8d3e | 116 | ENABLED: config.get<boolean>('signup.enabled'), |
980246ea | 117 | LIMIT: config.get<number>('signup.limit') |
b0f9f39e C |
118 | }, |
119 | USER: { | |
120 | VIDEO_QUOTA: config.get<number>('user.video_quota') | |
227d02fe C |
121 | }, |
122 | TRANSCODING: { | |
65fcc311 | 123 | ENABLED: config.get<boolean>('transcoding.enabled'), |
40298b02 C |
124 | THREADS: config.get<number>('transcoding.threads'), |
125 | RESOLUTIONS: { | |
126 | '240' : config.get<boolean>('transcoding.resolutions.240p'), | |
127 | '360': config.get<boolean>('transcoding.resolutions.360p'), | |
128 | '480': config.get<boolean>('transcoding.resolutions.480p'), | |
129 | '720': config.get<boolean>('transcoding.resolutions.720p'), | |
130 | '1080': config.get<boolean>('transcoding.resolutions.1080p') | |
131 | } | |
f981dae8 C |
132 | }, |
133 | CACHE: { | |
134 | PREVIEWS: { | |
135 | SIZE: config.get<number>('cache.previews.size') | |
136 | } | |
e861452f C |
137 | } |
138 | } | |
e861452f | 139 | |
9f6bae3a C |
140 | // --------------------------------------------------------------------------- |
141 | ||
e4c55619 C |
142 | const CONSTRAINTS_FIELDS = { |
143 | USERS: { | |
144 | USERNAME: { min: 3, max: 20 }, // Length | |
b0f9f39e C |
145 | PASSWORD: { min: 6, max: 255 }, // Length |
146 | VIDEO_QUOTA: { min: -1 } | |
e4c55619 | 147 | }, |
55fa55a9 C |
148 | VIDEO_ABUSES: { |
149 | REASON: { min: 2, max: 300 } // Length | |
150 | }, | |
72c7248b | 151 | VIDEO_CHANNELS: { |
a265f7f3 | 152 | NAME: { min: 3, max: 120 }, // Length |
e34c85e5 C |
153 | DESCRIPTION: { min: 3, max: 250 }, // Length |
154 | URL: { min: 3, max: 2000 } // Length | |
72c7248b | 155 | }, |
e4c55619 | 156 | VIDEOS: { |
a265f7f3 | 157 | NAME: { min: 3, max: 120 }, // Length |
9567011b C |
158 | TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length |
159 | DESCRIPTION: { min: 3, max: 3000 }, // Length | |
feb4bdfd | 160 | EXTNAME: [ '.mp4', '.ogv', '.webm' ], |
0e1dc3e7 | 161 | INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2 |
c60774b0 | 162 | DURATION: { min: 1 }, // Number |
a265f7f3 C |
163 | TAGS: { min: 0, max: 5 }, // Number of total tags |
164 | TAG: { min: 2, max: 30 }, // Length | |
e4c55619 | 165 | THUMBNAIL: { min: 2, max: 30 }, |
e4c87ec2 C |
166 | THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes |
167 | VIEWS: { min: 0 }, | |
168 | LIKES: { min: 0 }, | |
93e1258c | 169 | DISLIKES: { min: 0 }, |
c60774b0 | 170 | FILE_SIZE: { min: 10 }, |
e34c85e5 C |
171 | URL: { min: 3, max: 2000 } // Length |
172 | }, | |
01de67b9 | 173 | ACTORS: { |
e34c85e5 C |
174 | PUBLIC_KEY: { min: 10, max: 5000 }, // Length |
175 | PRIVATE_KEY: { min: 10, max: 5000 }, // Length | |
c5911fd3 C |
176 | URL: { min: 3, max: 2000 }, // Length |
177 | AVATAR: { | |
01de67b9 C |
178 | EXTNAME: [ '.png', '.jpeg', '.jpg' ], |
179 | FILE_SIZE: { | |
180 | max: 2 * 1024 * 1024 // 2MB | |
181 | } | |
c5911fd3 | 182 | } |
e4c87ec2 C |
183 | }, |
184 | VIDEO_EVENTS: { | |
185 | COUNT: { min: 0 } | |
6d852470 | 186 | }, |
bf1f6508 C |
187 | VIDEO_COMMENTS: { |
188 | TEXT: { min: 2, max: 3000 }, // Length | |
6d852470 | 189 | URL: { min: 3, max: 2000 } // Length |
e4c55619 C |
190 | } |
191 | } | |
192 | ||
ee9e7b61 | 193 | const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = { |
d38b8281 C |
194 | LIKE: 'like', |
195 | DISLIKE: 'dislike' | |
196 | } | |
197 | ||
6e07c3de C |
198 | const VIDEO_CATEGORIES = { |
199 | 1: 'Music', | |
200 | 2: 'Films', | |
201 | 3: 'Vehicles', | |
202 | 4: 'Art', | |
203 | 5: 'Sports', | |
204 | 6: 'Travels', | |
205 | 7: 'Gaming', | |
206 | 8: 'People', | |
207 | 9: 'Comedy', | |
208 | 10: 'Entertainment', | |
209 | 11: 'News', | |
40298b02 | 210 | 12: 'How To', |
6e07c3de C |
211 | 13: 'Education', |
212 | 14: 'Activism', | |
213 | 15: 'Science & Technology', | |
214 | 16: 'Animals', | |
215 | 17: 'Kids', | |
216 | 18: 'Food' | |
217 | } | |
218 | ||
6f0c39e2 C |
219 | // See https://creativecommons.org/licenses/?lang=en |
220 | const VIDEO_LICENCES = { | |
221 | 1: 'Attribution', | |
222 | 2: 'Attribution - Share Alike', | |
223 | 3: 'Attribution - No Derivatives', | |
224 | 4: 'Attribution - Non Commercial', | |
225 | 5: 'Attribution - Non Commercial - Share Alike', | |
226 | 6: 'Attribution - Non Commercial - No Derivatives', | |
227 | 7: 'Public Domain Dedication' | |
228 | } | |
229 | ||
3092476e C |
230 | // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin |
231 | const VIDEO_LANGUAGES = { | |
232 | 1: 'English', | |
233 | 2: 'Spanish', | |
234 | 3: 'Mandarin', | |
235 | 4: 'Hindi', | |
236 | 5: 'Arabic', | |
237 | 6: 'Portuguese', | |
238 | 7: 'Bengali', | |
239 | 8: 'Russian', | |
240 | 9: 'Japanese', | |
241 | 10: 'Punjabi', | |
242 | 11: 'German', | |
243 | 12: 'Korean', | |
244 | 13: 'French', | |
40298b02 | 245 | 14: 'Italian' |
3092476e C |
246 | } |
247 | ||
fd45e8f4 C |
248 | const VIDEO_PRIVACIES = { |
249 | [VideoPrivacy.PUBLIC]: 'Public', | |
250 | [VideoPrivacy.UNLISTED]: 'Unlisted', | |
251 | [VideoPrivacy.PRIVATE]: 'Private' | |
252 | } | |
253 | ||
0d0e8dd0 | 254 | const VIDEO_MIMETYPE_EXT = { |
efc32059 C |
255 | 'video/webm': '.webm', |
256 | 'video/ogg': '.ogv', | |
257 | 'video/mp4': '.mp4' | |
0d0e8dd0 C |
258 | } |
259 | ||
c5911fd3 C |
260 | const AVATAR_MIMETYPE_EXT = { |
261 | 'image/png': '.png', | |
262 | 'image/jpg': '.jpg', | |
263 | 'image/jpeg': '.jpg' | |
264 | } | |
265 | ||
9f6bae3a C |
266 | // --------------------------------------------------------------------------- |
267 | ||
50d6de9c | 268 | const SERVER_ACTOR_NAME = 'peertube' |
350e31d6 | 269 | |
e4f97bab | 270 | const ACTIVITY_PUB = { |
1b5b10d1 C |
271 | POTENTIAL_ACCEPT_HEADERS: [ |
272 | 'application/activity+json', | |
273 | 'application/ld+json' | |
165cdc75 | 274 | ], |
1b5b10d1 | 275 | ACCEPT_HEADER: 'application/activity+json, application/ld+json', |
9a27cdc2 | 276 | PUBLIC: 'https://www.w3.org/ns/activitystreams#Public', |
0d0e8dd0 | 277 | COLLECTION_ITEMS_PER_PAGE: 10, |
c986175d | 278 | FETCH_PAGE_LIMIT: 100, |
0032ebe9 | 279 | MAX_HTTP_ATTEMPT: 5, |
20494f12 C |
280 | URL_MIME_TYPES: { |
281 | VIDEO: [ 'video/mp4', 'video/webm', 'video/ogg' ], // TODO: Merge with VIDEO_MIMETYPE_EXT | |
282 | TORRENT: [ 'application/x-bittorrent' ], | |
283 | MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ] | |
a5625b41 | 284 | }, |
2ccaeeb3 | 285 | MAX_RECURSION_COMMENTS: 100, |
7bc29171 | 286 | ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day |
e4f97bab C |
287 | } |
288 | ||
50d6de9c C |
289 | const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = { |
290 | GROUP: 'Group', | |
291 | PERSON: 'Person', | |
292 | APPLICATION: 'Application' | |
293 | } | |
294 | ||
9f6bae3a C |
295 | // --------------------------------------------------------------------------- |
296 | ||
e4f97bab | 297 | const PRIVATE_RSA_KEY_SIZE = 2048 |
bdfbd4f1 | 298 | |
9f6bae3a C |
299 | // Password encryption |
300 | const BCRYPT_SALT_SIZE = 10 | |
a877d5ac | 301 | |
bdfbd4f1 C |
302 | // --------------------------------------------------------------------------- |
303 | ||
052937db C |
304 | // Express static paths (router) |
305 | const STATIC_PATHS = { | |
f285faa0 C |
306 | PREVIEWS: '/static/previews/', |
307 | THUMBNAILS: '/static/thumbnails/', | |
052937db | 308 | TORRENTS: '/static/torrents/', |
c5911fd3 C |
309 | WEBSEED: '/static/webseed/', |
310 | AVATARS: '/static/avatars/' | |
052937db C |
311 | } |
312 | ||
dc009132 C |
313 | // Cache control |
314 | let STATIC_MAX_AGE = '30d' | |
315 | ||
cbe2f7c3 | 316 | // Videos thumbnail size |
d8755eed C |
317 | const THUMBNAILS_SIZE = { |
318 | width: 200, | |
319 | height: 110 | |
320 | } | |
321 | const PREVIEWS_SIZE = { | |
164174a6 C |
322 | width: 560, |
323 | height: 315 | |
324 | } | |
e8e12200 C |
325 | const AVATARS_SIZE = { |
326 | width: 120, | |
327 | height: 120 | |
328 | } | |
164174a6 C |
329 | |
330 | const EMBED_SIZE = { | |
331 | width: 560, | |
332 | height: 315 | |
d8755eed | 333 | } |
cbe2f7c3 | 334 | |
980246ea | 335 | // Sub folders of cache directory |
f981dae8 C |
336 | const CACHE = { |
337 | DIRECTORIES: { | |
338 | PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews') | |
339 | } | |
340 | } | |
341 | ||
e12a0092 | 342 | const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS) |
4f491371 | 343 | |
bdfbd4f1 C |
344 | // --------------------------------------------------------------------------- |
345 | ||
d8755eed | 346 | const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->' |
709756b8 C |
347 | |
348 | // --------------------------------------------------------------------------- | |
349 | ||
9f10b292 C |
350 | // Special constants for a test instance |
351 | if (isTestInstance() === true) { | |
60650c77 | 352 | ACTOR_FOLLOW_SCORE.BASE = 20 |
0f91ae62 | 353 | JOBS_FETCHING_INTERVAL = 1000 |
f285faa0 C |
354 | REMOTE_SCHEME.HTTP = 'http' |
355 | REMOTE_SCHEME.WS = 'ws' | |
65fcc311 | 356 | STATIC_MAX_AGE = '0' |
c46edbc2 | 357 | ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2 |
7bc29171 | 358 | ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds |
01de67b9 | 359 | CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB |
60650c77 | 360 | SCHEDULER_INTERVAL = 10000 |
9f10b292 C |
361 | } |
362 | ||
225a89c2 C |
363 | CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT) |
364 | CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP) | |
365 | ||
9f10b292 C |
366 | // --------------------------------------------------------------------------- |
367 | ||
65fcc311 | 368 | export { |
9f6bae3a | 369 | API_VERSION, |
e8e12200 | 370 | AVATARS_SIZE, |
4f491371 | 371 | ACCEPT_HEADERS, |
9f6bae3a | 372 | BCRYPT_SALT_SIZE, |
f981dae8 | 373 | CACHE, |
9f6bae3a C |
374 | CONFIG, |
375 | CONSTRAINTS_FIELDS, | |
164174a6 | 376 | EMBED_SIZE, |
227d02fe | 377 | JOB_STATES, |
227d02fe | 378 | JOBS_FETCH_LIMIT_PER_CYCLE, |
709756b8 | 379 | JOBS_FETCHING_INTERVAL, |
e4f97bab | 380 | JOB_CATEGORIES, |
b769007f | 381 | LAST_MIGRATION_VERSION, |
9f6bae3a | 382 | OAUTH_LIFETIME, |
d8755eed | 383 | OPENGRAPH_AND_OEMBED_COMMENT, |
9f6bae3a | 384 | PAGINATION_COUNT_DEFAULT, |
60650c77 | 385 | ACTOR_FOLLOW_SCORE, |
f285faa0 C |
386 | PREVIEWS_SIZE, |
387 | REMOTE_SCHEME, | |
7a7724e6 | 388 | FOLLOW_STATES, |
50d6de9c | 389 | SERVER_ACTOR_NAME, |
e4f97bab | 390 | PRIVATE_RSA_KEY_SIZE, |
9f6bae3a | 391 | SORTABLE_COLUMNS, |
dc009132 | 392 | STATIC_MAX_AGE, |
a6375e69 | 393 | STATIC_PATHS, |
e4f97bab | 394 | ACTIVITY_PUB, |
50d6de9c | 395 | ACTIVITY_PUB_ACTOR_TYPES, |
9f6bae3a | 396 | THUMBNAILS_SIZE, |
6e07c3de | 397 | VIDEO_CATEGORIES, |
3092476e | 398 | VIDEO_LANGUAGES, |
fd45e8f4 | 399 | VIDEO_PRIVACIES, |
6f0c39e2 | 400 | VIDEO_LICENCES, |
0d0e8dd0 | 401 | VIDEO_RATE_TYPES, |
c5911fd3 | 402 | VIDEO_MIMETYPE_EXT, |
60650c77 C |
403 | AVATAR_MIMETYPE_EXT, |
404 | SCHEDULER_INTERVAL | |
9f10b292 | 405 | } |