]>
Commit | Line | Data |
---|---|---|
1 | import { IConfig } from 'config' | |
2 | import { dirname, join } from 'path' | |
3 | import { JobType, VideoRateType, VideoRedundancyStrategy, VideoState, VideosRedundancy } from '../../shared/models' | |
4 | import { ActivityPubActorType } from '../../shared/models/activitypub' | |
5 | import { FollowState } from '../../shared/models/actors' | |
6 | import { VideoAbuseState, VideoImportState, VideoPrivacy } from '../../shared/models/videos' | |
7 | // Do not use barrels, remain constants as independent as possible | |
8 | import { buildPath, isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils' | |
9 | import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type' | |
10 | import { invert } from 'lodash' | |
11 | import { CronRepeatOptions, EveryRepeatOptions } from 'bull' | |
12 | import * as bytes from 'bytes' | |
13 | ||
14 | // Use a variable to reload the configuration if we need | |
15 | let config: IConfig = require('config') | |
16 | ||
17 | // --------------------------------------------------------------------------- | |
18 | ||
19 | const LAST_MIGRATION_VERSION = 270 | |
20 | ||
21 | // --------------------------------------------------------------------------- | |
22 | ||
23 | // API version | |
24 | const API_VERSION = 'v1' | |
25 | ||
26 | const PAGINATION = { | |
27 | COUNT: { | |
28 | DEFAULT: 15, | |
29 | MAX: 100 | |
30 | } | |
31 | } | |
32 | ||
33 | // Sortable columns per schema | |
34 | const SORTABLE_COLUMNS = { | |
35 | USERS: [ 'id', 'username', 'createdAt' ], | |
36 | USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ], | |
37 | ACCOUNTS: [ 'createdAt' ], | |
38 | JOBS: [ 'createdAt' ], | |
39 | VIDEO_ABUSES: [ 'id', 'createdAt', 'state' ], | |
40 | VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ], | |
41 | VIDEO_IMPORTS: [ 'createdAt' ], | |
42 | VIDEO_COMMENT_THREADS: [ 'createdAt' ], | |
43 | BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ], | |
44 | FOLLOWERS: [ 'createdAt' ], | |
45 | FOLLOWING: [ 'createdAt' ], | |
46 | ||
47 | VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'trending' ], | |
48 | ||
49 | VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'views', 'likes', 'match' ], | |
50 | VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ] | |
51 | } | |
52 | ||
53 | const OAUTH_LIFETIME = { | |
54 | ACCESS_TOKEN: 3600 * 24, // 1 day, for upload | |
55 | REFRESH_TOKEN: 1209600 // 2 weeks | |
56 | } | |
57 | ||
58 | const ROUTE_CACHE_LIFETIME = { | |
59 | FEEDS: '15 minutes', | |
60 | ROBOTS: '2 hours', | |
61 | SECURITYTXT: '2 hours', | |
62 | NODEINFO: '10 minutes', | |
63 | DNT_POLICY: '1 week', | |
64 | OVERVIEWS: { | |
65 | VIDEOS: '1 hour' | |
66 | }, | |
67 | ACTIVITY_PUB: { | |
68 | VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example | |
69 | } | |
70 | } | |
71 | ||
72 | // --------------------------------------------------------------------------- | |
73 | ||
74 | // Number of points we add/remove after a successful/bad request | |
75 | const ACTOR_FOLLOW_SCORE = { | |
76 | PENALTY: -10, | |
77 | BONUS: 10, | |
78 | BASE: 1000, | |
79 | MAX: 10000 | |
80 | } | |
81 | ||
82 | const FOLLOW_STATES: { [ id: string ]: FollowState } = { | |
83 | PENDING: 'pending', | |
84 | ACCEPTED: 'accepted' | |
85 | } | |
86 | ||
87 | const REMOTE_SCHEME = { | |
88 | HTTP: 'https', | |
89 | WS: 'wss' | |
90 | } | |
91 | ||
92 | const JOB_ATTEMPTS: { [ id in JobType ]: number } = { | |
93 | 'activitypub-http-broadcast': 5, | |
94 | 'activitypub-http-unicast': 5, | |
95 | 'activitypub-http-fetcher': 5, | |
96 | 'activitypub-follow': 5, | |
97 | 'video-file-import': 1, | |
98 | 'video-file': 1, | |
99 | 'video-import': 1, | |
100 | 'email': 5, | |
101 | 'videos-views': 1 | |
102 | } | |
103 | const JOB_CONCURRENCY: { [ id in JobType ]: number } = { | |
104 | 'activitypub-http-broadcast': 1, | |
105 | 'activitypub-http-unicast': 5, | |
106 | 'activitypub-http-fetcher': 1, | |
107 | 'activitypub-follow': 3, | |
108 | 'video-file-import': 1, | |
109 | 'video-file': 1, | |
110 | 'video-import': 1, | |
111 | 'email': 5, | |
112 | 'videos-views': 1 | |
113 | } | |
114 | const JOB_TTL: { [ id in JobType ]: number } = { | |
115 | 'activitypub-http-broadcast': 60000 * 10, // 10 minutes | |
116 | 'activitypub-http-unicast': 60000 * 10, // 10 minutes | |
117 | 'activitypub-http-fetcher': 60000 * 10, // 10 minutes | |
118 | 'activitypub-follow': 60000 * 10, // 10 minutes | |
119 | 'video-file-import': 1000 * 3600, // 1 hour | |
120 | 'video-file': 1000 * 3600 * 48, // 2 days, transcoding could be long | |
121 | 'video-import': 1000 * 3600 * 5, // 5 hours | |
122 | 'email': 60000 * 10, // 10 minutes | |
123 | 'videos-views': undefined // Unlimited | |
124 | } | |
125 | const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = { | |
126 | 'videos-views': { | |
127 | cron: '1 * * * *' // At 1 minutes past the hour | |
128 | } | |
129 | } | |
130 | ||
131 | const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job | |
132 | const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...) | |
133 | const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds | |
134 | const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days | |
135 | ||
136 | // 1 hour | |
137 | let SCHEDULER_INTERVALS_MS = { | |
138 | badActorFollow: 60000 * 60, // 1 hour | |
139 | removeOldJobs: 60000 * 60, // 1 hour | |
140 | updateVideos: 60000, // 1 minute | |
141 | youtubeDLUpdate: 60000 * 60 * 24, // 1 day | |
142 | videosRedundancy: 60000 * 2 // 2 hours | |
143 | } | |
144 | ||
145 | // --------------------------------------------------------------------------- | |
146 | ||
147 | const CONFIG = { | |
148 | CUSTOM_FILE: getLocalConfigFilePath(), | |
149 | LISTEN: { | |
150 | PORT: config.get<number>('listen.port'), | |
151 | HOSTNAME: config.get<string>('listen.hostname') | |
152 | }, | |
153 | DATABASE: { | |
154 | DBNAME: 'peertube' + config.get<string>('database.suffix'), | |
155 | HOSTNAME: config.get<string>('database.hostname'), | |
156 | PORT: config.get<number>('database.port'), | |
157 | USERNAME: config.get<string>('database.username'), | |
158 | PASSWORD: config.get<string>('database.password'), | |
159 | POOL: { | |
160 | MAX: config.get<number>('database.pool.max') | |
161 | } | |
162 | }, | |
163 | REDIS: { | |
164 | HOSTNAME: config.has('redis.hostname') ? config.get<string>('redis.hostname') : null, | |
165 | PORT: config.has('redis.port') ? config.get<number>('redis.port') : null, | |
166 | SOCKET: config.has('redis.socket') ? config.get<string>('redis.socket') : null, | |
167 | AUTH: config.has('redis.auth') ? config.get<string>('redis.auth') : null, | |
168 | DB: config.has('redis.db') ? config.get<number>('redis.db') : null | |
169 | }, | |
170 | SMTP: { | |
171 | HOSTNAME: config.get<string>('smtp.hostname'), | |
172 | PORT: config.get<number>('smtp.port'), | |
173 | USERNAME: config.get<string>('smtp.username'), | |
174 | PASSWORD: config.get<string>('smtp.password'), | |
175 | TLS: config.get<boolean>('smtp.tls'), | |
176 | DISABLE_STARTTLS: config.get<boolean>('smtp.disable_starttls'), | |
177 | CA_FILE: config.get<string>('smtp.ca_file'), | |
178 | FROM_ADDRESS: config.get<string>('smtp.from_address') | |
179 | }, | |
180 | STORAGE: { | |
181 | AVATARS_DIR: buildPath(config.get<string>('storage.avatars')), | |
182 | LOG_DIR: buildPath(config.get<string>('storage.logs')), | |
183 | VIDEOS_DIR: buildPath(config.get<string>('storage.videos')), | |
184 | THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')), | |
185 | PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')), | |
186 | CAPTIONS_DIR: buildPath(config.get<string>('storage.captions')), | |
187 | TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')), | |
188 | CACHE_DIR: buildPath(config.get<string>('storage.cache')) | |
189 | }, | |
190 | WEBSERVER: { | |
191 | SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http', | |
192 | WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws', | |
193 | HOSTNAME: config.get<string>('webserver.hostname'), | |
194 | PORT: config.get<number>('webserver.port'), | |
195 | URL: '', | |
196 | HOST: '' | |
197 | }, | |
198 | TRUST_PROXY: config.get<string[]>('trust_proxy'), | |
199 | LOG: { | |
200 | LEVEL: config.get<string>('log.level') | |
201 | }, | |
202 | SEARCH: { | |
203 | REMOTE_URI: { | |
204 | USERS: config.get<boolean>('search.remote_uri.users'), | |
205 | ANONYMOUS: config.get<boolean>('search.remote_uri.anonymous') | |
206 | } | |
207 | }, | |
208 | TRENDING: { | |
209 | VIDEOS: { | |
210 | INTERVAL_DAYS: config.get<number>('trending.videos.interval_days') | |
211 | } | |
212 | }, | |
213 | REDUNDANCY: { | |
214 | VIDEOS: buildVideosRedundancy(config.get<any[]>('redundancy.videos')) | |
215 | }, | |
216 | ADMIN: { | |
217 | get EMAIL () { return config.get<string>('admin.email') } | |
218 | }, | |
219 | SIGNUP: { | |
220 | get ENABLED () { return config.get<boolean>('signup.enabled') }, | |
221 | get LIMIT () { return config.get<number>('signup.limit') }, | |
222 | get REQUIRES_EMAIL_VERIFICATION () { return config.get<boolean>('signup.requires_email_verification') }, | |
223 | FILTERS: { | |
224 | CIDR: { | |
225 | get WHITELIST () { return config.get<string[]>('signup.filters.cidr.whitelist') }, | |
226 | get BLACKLIST () { return config.get<string[]>('signup.filters.cidr.blacklist') } | |
227 | } | |
228 | } | |
229 | }, | |
230 | USER: { | |
231 | get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }, | |
232 | get VIDEO_QUOTA_DAILY () { return config.get<number>('user.video_quota_daily') } | |
233 | }, | |
234 | TRANSCODING: { | |
235 | get ENABLED () { return config.get<boolean>('transcoding.enabled') }, | |
236 | get THREADS () { return config.get<number>('transcoding.threads') }, | |
237 | RESOLUTIONS: { | |
238 | get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') }, | |
239 | get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') }, | |
240 | get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') }, | |
241 | get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') }, | |
242 | get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') } | |
243 | } | |
244 | }, | |
245 | IMPORT: { | |
246 | VIDEOS: { | |
247 | HTTP: { | |
248 | get ENABLED () { return config.get<boolean>('import.videos.http.enabled') } | |
249 | }, | |
250 | TORRENT: { | |
251 | get ENABLED () { return config.get<boolean>('import.videos.torrent.enabled') } | |
252 | } | |
253 | } | |
254 | }, | |
255 | CACHE: { | |
256 | PREVIEWS: { | |
257 | get SIZE () { return config.get<number>('cache.previews.size') } | |
258 | }, | |
259 | VIDEO_CAPTIONS: { | |
260 | get SIZE () { return config.get<number>('cache.captions.size') } | |
261 | } | |
262 | }, | |
263 | INSTANCE: { | |
264 | get NAME () { return config.get<string>('instance.name') }, | |
265 | get SHORT_DESCRIPTION () { return config.get<string>('instance.short_description') }, | |
266 | get DESCRIPTION () { return config.get<string>('instance.description') }, | |
267 | get TERMS () { return config.get<string>('instance.terms') }, | |
268 | get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') }, | |
269 | get DEFAULT_NSFW_POLICY () { return config.get<NSFWPolicyType>('instance.default_nsfw_policy') }, | |
270 | CUSTOMIZATIONS: { | |
271 | get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') }, | |
272 | get CSS () { return config.get<string>('instance.customizations.css') } | |
273 | }, | |
274 | get ROBOTS () { return config.get<string>('instance.robots') }, | |
275 | get SECURITYTXT () { return config.get<string>('instance.securitytxt') }, | |
276 | get SECURITYTXT_CONTACT () { return config.get<string>('admin.email') } | |
277 | }, | |
278 | SERVICES: { | |
279 | TWITTER: { | |
280 | get USERNAME () { return config.get<string>('services.twitter.username') }, | |
281 | get WHITELISTED () { return config.get<boolean>('services.twitter.whitelisted') } | |
282 | } | |
283 | } | |
284 | } | |
285 | ||
286 | // --------------------------------------------------------------------------- | |
287 | ||
288 | const CONSTRAINTS_FIELDS = { | |
289 | USERS: { | |
290 | NAME: { min: 3, max: 120 }, // Length | |
291 | DESCRIPTION: { min: 3, max: 250 }, // Length | |
292 | USERNAME: { min: 3, max: 20 }, // Length | |
293 | PASSWORD: { min: 6, max: 255 }, // Length | |
294 | VIDEO_QUOTA: { min: -1 }, | |
295 | VIDEO_QUOTA_DAILY: { min: -1 }, | |
296 | BLOCKED_REASON: { min: 3, max: 250 } // Length | |
297 | }, | |
298 | VIDEO_ABUSES: { | |
299 | REASON: { min: 2, max: 300 }, // Length | |
300 | MODERATION_COMMENT: { min: 2, max: 300 } // Length | |
301 | }, | |
302 | VIDEO_BLACKLIST: { | |
303 | REASON: { min: 2, max: 300 } // Length | |
304 | }, | |
305 | VIDEO_CHANNELS: { | |
306 | NAME: { min: 3, max: 120 }, // Length | |
307 | DESCRIPTION: { min: 3, max: 500 }, // Length | |
308 | SUPPORT: { min: 3, max: 500 }, // Length | |
309 | URL: { min: 3, max: 2000 } // Length | |
310 | }, | |
311 | VIDEO_CAPTIONS: { | |
312 | CAPTION_FILE: { | |
313 | EXTNAME: [ '.vtt', '.srt' ], | |
314 | FILE_SIZE: { | |
315 | max: 2 * 1024 * 1024 // 2MB | |
316 | } | |
317 | } | |
318 | }, | |
319 | VIDEO_IMPORTS: { | |
320 | URL: { min: 3, max: 2000 }, // Length | |
321 | TORRENT_NAME: { min: 3, max: 255 }, // Length | |
322 | TORRENT_FILE: { | |
323 | EXTNAME: [ '.torrent' ], | |
324 | FILE_SIZE: { | |
325 | max: 1024 * 200 // 200 KB | |
326 | } | |
327 | } | |
328 | }, | |
329 | VIDEOS_REDUNDANCY: { | |
330 | URL: { min: 3, max: 2000 } // Length | |
331 | }, | |
332 | VIDEOS: { | |
333 | NAME: { min: 3, max: 120 }, // Length | |
334 | LANGUAGE: { min: 1, max: 10 }, // Length | |
335 | TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length | |
336 | DESCRIPTION: { min: 3, max: 10000 }, // Length | |
337 | SUPPORT: { min: 3, max: 500 }, // Length | |
338 | IMAGE: { | |
339 | EXTNAME: [ '.jpg', '.jpeg' ], | |
340 | FILE_SIZE: { | |
341 | max: 2 * 1024 * 1024 // 2MB | |
342 | } | |
343 | }, | |
344 | EXTNAME: [ '.mp4', '.ogv', '.webm' ], | |
345 | INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2 | |
346 | DURATION: { min: 0 }, // Number | |
347 | TAGS: { min: 0, max: 5 }, // Number of total tags | |
348 | TAG: { min: 2, max: 30 }, // Length | |
349 | THUMBNAIL: { min: 2, max: 30 }, | |
350 | THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes | |
351 | VIEWS: { min: 0 }, | |
352 | LIKES: { min: 0 }, | |
353 | DISLIKES: { min: 0 }, | |
354 | FILE_SIZE: { min: 10 }, | |
355 | URL: { min: 3, max: 2000 } // Length | |
356 | }, | |
357 | ACTORS: { | |
358 | PUBLIC_KEY: { min: 10, max: 5000 }, // Length | |
359 | PRIVATE_KEY: { min: 10, max: 5000 }, // Length | |
360 | URL: { min: 3, max: 2000 }, // Length | |
361 | AVATAR: { | |
362 | EXTNAME: [ '.png', '.jpeg', '.jpg' ], | |
363 | FILE_SIZE: { | |
364 | max: 2 * 1024 * 1024 // 2MB | |
365 | } | |
366 | } | |
367 | }, | |
368 | VIDEO_EVENTS: { | |
369 | COUNT: { min: 0 } | |
370 | }, | |
371 | VIDEO_COMMENTS: { | |
372 | TEXT: { min: 1, max: 3000 }, // Length | |
373 | URL: { min: 3, max: 2000 } // Length | |
374 | }, | |
375 | VIDEO_SHARE: { | |
376 | URL: { min: 3, max: 2000 } // Length | |
377 | } | |
378 | } | |
379 | ||
380 | const RATES_LIMIT = { | |
381 | LOGIN: { | |
382 | WINDOW_MS: 5 * 60 * 1000, // 5 minutes | |
383 | MAX: 15 // 15 attempts | |
384 | }, | |
385 | ASK_SEND_EMAIL: { | |
386 | WINDOW_MS: 5 * 60 * 1000, // 5 minutes | |
387 | MAX: 3 // 3 attempts | |
388 | } | |
389 | } | |
390 | ||
391 | let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour | |
392 | const VIDEO_TRANSCODING_FPS = { | |
393 | MIN: 10, | |
394 | AVERAGE: 30, | |
395 | MAX: 60, | |
396 | KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum) | |
397 | } | |
398 | ||
399 | const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = { | |
400 | LIKE: 'like', | |
401 | DISLIKE: 'dislike' | |
402 | } | |
403 | ||
404 | const FFMPEG_NICE: { [ id: string ]: number } = { | |
405 | THUMBNAIL: 2, // 2 just for don't blocking servers | |
406 | TRANSCODING: 15 | |
407 | } | |
408 | ||
409 | const VIDEO_CATEGORIES = { | |
410 | 1: 'Music', | |
411 | 2: 'Films', | |
412 | 3: 'Vehicles', | |
413 | 4: 'Art', | |
414 | 5: 'Sports', | |
415 | 6: 'Travels', | |
416 | 7: 'Gaming', | |
417 | 8: 'People', | |
418 | 9: 'Comedy', | |
419 | 10: 'Entertainment', | |
420 | 11: 'News', | |
421 | 12: 'How To', | |
422 | 13: 'Education', | |
423 | 14: 'Activism', | |
424 | 15: 'Science & Technology', | |
425 | 16: 'Animals', | |
426 | 17: 'Kids', | |
427 | 18: 'Food' | |
428 | } | |
429 | ||
430 | // See https://creativecommons.org/licenses/?lang=en | |
431 | const VIDEO_LICENCES = { | |
432 | 1: 'Attribution', | |
433 | 2: 'Attribution - Share Alike', | |
434 | 3: 'Attribution - No Derivatives', | |
435 | 4: 'Attribution - Non Commercial', | |
436 | 5: 'Attribution - Non Commercial - Share Alike', | |
437 | 6: 'Attribution - Non Commercial - No Derivatives', | |
438 | 7: 'Public Domain Dedication' | |
439 | } | |
440 | ||
441 | const VIDEO_LANGUAGES = buildLanguages() | |
442 | ||
443 | const VIDEO_PRIVACIES = { | |
444 | [VideoPrivacy.PUBLIC]: 'Public', | |
445 | [VideoPrivacy.UNLISTED]: 'Unlisted', | |
446 | [VideoPrivacy.PRIVATE]: 'Private' | |
447 | } | |
448 | ||
449 | const VIDEO_STATES = { | |
450 | [VideoState.PUBLISHED]: 'Published', | |
451 | [VideoState.TO_TRANSCODE]: 'To transcode', | |
452 | [VideoState.TO_IMPORT]: 'To import' | |
453 | } | |
454 | ||
455 | const VIDEO_IMPORT_STATES = { | |
456 | [VideoImportState.FAILED]: 'Failed', | |
457 | [VideoImportState.PENDING]: 'Pending', | |
458 | [VideoImportState.SUCCESS]: 'Success' | |
459 | } | |
460 | ||
461 | const VIDEO_ABUSE_STATES = { | |
462 | [VideoAbuseState.PENDING]: 'Pending', | |
463 | [VideoAbuseState.REJECTED]: 'Rejected', | |
464 | [VideoAbuseState.ACCEPTED]: 'Accepted' | |
465 | } | |
466 | ||
467 | const VIDEO_MIMETYPE_EXT = { | |
468 | 'video/webm': '.webm', | |
469 | 'video/ogg': '.ogv', | |
470 | 'video/mp4': '.mp4' | |
471 | } | |
472 | const VIDEO_EXT_MIMETYPE = invert(VIDEO_MIMETYPE_EXT) | |
473 | ||
474 | const IMAGE_MIMETYPE_EXT = { | |
475 | 'image/png': '.png', | |
476 | 'image/jpg': '.jpg', | |
477 | 'image/jpeg': '.jpg' | |
478 | } | |
479 | ||
480 | const VIDEO_CAPTIONS_MIMETYPE_EXT = { | |
481 | 'text/vtt': '.vtt', | |
482 | 'application/x-subrip': '.srt' | |
483 | } | |
484 | ||
485 | const TORRENT_MIMETYPE_EXT = { | |
486 | 'application/x-bittorrent': '.torrent' | |
487 | } | |
488 | ||
489 | // --------------------------------------------------------------------------- | |
490 | ||
491 | const OVERVIEWS = { | |
492 | VIDEOS: { | |
493 | SAMPLE_THRESHOLD: 6, | |
494 | SAMPLES_COUNT: 2 | |
495 | } | |
496 | } | |
497 | ||
498 | // --------------------------------------------------------------------------- | |
499 | ||
500 | const SERVER_ACTOR_NAME = 'peertube' | |
501 | ||
502 | const ACTIVITY_PUB = { | |
503 | POTENTIAL_ACCEPT_HEADERS: [ | |
504 | 'application/activity+json', | |
505 | 'application/ld+json', | |
506 | 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"' | |
507 | ], | |
508 | ACCEPT_HEADER: 'application/activity+json, application/ld+json', | |
509 | PUBLIC: 'https://www.w3.org/ns/activitystreams#Public', | |
510 | COLLECTION_ITEMS_PER_PAGE: 10, | |
511 | FETCH_PAGE_LIMIT: 100, | |
512 | URL_MIME_TYPES: { | |
513 | VIDEO: Object.keys(VIDEO_MIMETYPE_EXT), | |
514 | TORRENT: [ 'application/x-bittorrent' ], | |
515 | MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ] | |
516 | }, | |
517 | MAX_RECURSION_COMMENTS: 100, | |
518 | ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000, // 1 day | |
519 | VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day | |
520 | } | |
521 | ||
522 | const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = { | |
523 | GROUP: 'Group', | |
524 | PERSON: 'Person', | |
525 | APPLICATION: 'Application' | |
526 | } | |
527 | ||
528 | // --------------------------------------------------------------------------- | |
529 | ||
530 | const PRIVATE_RSA_KEY_SIZE = 2048 | |
531 | ||
532 | // Password encryption | |
533 | const BCRYPT_SALT_SIZE = 10 | |
534 | ||
535 | const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes | |
536 | ||
537 | const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes | |
538 | ||
539 | const NSFW_POLICY_TYPES: { [ id: string]: NSFWPolicyType } = { | |
540 | DO_NOT_LIST: 'do_not_list', | |
541 | BLUR: 'blur', | |
542 | DISPLAY: 'display' | |
543 | } | |
544 | ||
545 | // --------------------------------------------------------------------------- | |
546 | ||
547 | // Express static paths (router) | |
548 | const STATIC_PATHS = { | |
549 | PREVIEWS: '/static/previews/', | |
550 | THUMBNAILS: '/static/thumbnails/', | |
551 | TORRENTS: '/static/torrents/', | |
552 | WEBSEED: '/static/webseed/', | |
553 | AVATARS: '/static/avatars/', | |
554 | VIDEO_CAPTIONS: '/static/video-captions/' | |
555 | } | |
556 | const STATIC_DOWNLOAD_PATHS = { | |
557 | TORRENTS: '/download/torrents/', | |
558 | VIDEOS: '/download/videos/' | |
559 | } | |
560 | ||
561 | // Cache control | |
562 | let STATIC_MAX_AGE = '2h' | |
563 | ||
564 | // Videos thumbnail size | |
565 | const THUMBNAILS_SIZE = { | |
566 | width: 200, | |
567 | height: 110 | |
568 | } | |
569 | const PREVIEWS_SIZE = { | |
570 | width: 560, | |
571 | height: 315 | |
572 | } | |
573 | const AVATARS_SIZE = { | |
574 | width: 120, | |
575 | height: 120 | |
576 | } | |
577 | ||
578 | const EMBED_SIZE = { | |
579 | width: 560, | |
580 | height: 315 | |
581 | } | |
582 | ||
583 | // Sub folders of cache directory | |
584 | const CACHE = { | |
585 | PREVIEWS: { | |
586 | DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'), | |
587 | MAX_AGE: 1000 * 3600 * 3 // 3 hours | |
588 | }, | |
589 | VIDEO_CAPTIONS: { | |
590 | DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'), | |
591 | MAX_AGE: 1000 * 3600 * 3 // 3 hours | |
592 | } | |
593 | } | |
594 | ||
595 | const REDUNDANCY = { | |
596 | VIDEOS: { | |
597 | EXPIRES_AFTER_MS: 48 * 3600 * 1000, // 2 days | |
598 | RANDOMIZED_FACTOR: 5 | |
599 | } | |
600 | } | |
601 | ||
602 | const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS) | |
603 | ||
604 | // --------------------------------------------------------------------------- | |
605 | ||
606 | const CUSTOM_HTML_TAG_COMMENTS = { | |
607 | TITLE: '<!-- title tag -->', | |
608 | DESCRIPTION: '<!-- description tag -->', | |
609 | CUSTOM_CSS: '<!-- custom css tag -->', | |
610 | OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->' | |
611 | } | |
612 | ||
613 | // --------------------------------------------------------------------------- | |
614 | ||
615 | const FEEDS = { | |
616 | COUNT: 20 | |
617 | } | |
618 | ||
619 | // --------------------------------------------------------------------------- | |
620 | ||
621 | const TRACKER_RATE_LIMITS = { | |
622 | INTERVAL: 60000 * 5, // 5 minutes | |
623 | ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval | |
624 | ANNOUNCES_PER_IP: 30 // maximum announces for all our torrents in the interval | |
625 | } | |
626 | ||
627 | // --------------------------------------------------------------------------- | |
628 | ||
629 | // Special constants for a test instance | |
630 | if (isTestInstance() === true) { | |
631 | ACTOR_FOLLOW_SCORE.BASE = 20 | |
632 | ||
633 | REMOTE_SCHEME.HTTP = 'http' | |
634 | REMOTE_SCHEME.WS = 'ws' | |
635 | ||
636 | STATIC_MAX_AGE = '0' | |
637 | ||
638 | ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2 | |
639 | ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds | |
640 | ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds | |
641 | ||
642 | CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB | |
643 | ||
644 | SCHEDULER_INTERVALS_MS.badActorFollow = 10000 | |
645 | SCHEDULER_INTERVALS_MS.removeOldJobs = 10000 | |
646 | SCHEDULER_INTERVALS_MS.updateVideos = 5000 | |
647 | SCHEDULER_INTERVALS_MS.videosRedundancy = 5000 | |
648 | REPEAT_JOBS['videos-views'] = { every: 5000 } | |
649 | ||
650 | REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1 | |
651 | ||
652 | VIDEO_VIEW_LIFETIME = 1000 // 1 second | |
653 | ||
654 | JOB_ATTEMPTS['email'] = 1 | |
655 | ||
656 | CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000 | |
657 | } | |
658 | ||
659 | updateWebserverConfig() | |
660 | ||
661 | // --------------------------------------------------------------------------- | |
662 | ||
663 | export { | |
664 | API_VERSION, | |
665 | VIDEO_CAPTIONS_MIMETYPE_EXT, | |
666 | AVATARS_SIZE, | |
667 | ACCEPT_HEADERS, | |
668 | BCRYPT_SALT_SIZE, | |
669 | TRACKER_RATE_LIMITS, | |
670 | CACHE, | |
671 | CONFIG, | |
672 | CONSTRAINTS_FIELDS, | |
673 | EMBED_SIZE, | |
674 | REDUNDANCY, | |
675 | JOB_CONCURRENCY, | |
676 | JOB_ATTEMPTS, | |
677 | LAST_MIGRATION_VERSION, | |
678 | OAUTH_LIFETIME, | |
679 | CUSTOM_HTML_TAG_COMMENTS, | |
680 | BROADCAST_CONCURRENCY, | |
681 | PAGINATION, | |
682 | ACTOR_FOLLOW_SCORE, | |
683 | PREVIEWS_SIZE, | |
684 | REMOTE_SCHEME, | |
685 | FOLLOW_STATES, | |
686 | SERVER_ACTOR_NAME, | |
687 | PRIVATE_RSA_KEY_SIZE, | |
688 | ROUTE_CACHE_LIFETIME, | |
689 | SORTABLE_COLUMNS, | |
690 | FEEDS, | |
691 | JOB_TTL, | |
692 | NSFW_POLICY_TYPES, | |
693 | TORRENT_MIMETYPE_EXT, | |
694 | STATIC_MAX_AGE, | |
695 | STATIC_PATHS, | |
696 | ACTIVITY_PUB, | |
697 | ACTIVITY_PUB_ACTOR_TYPES, | |
698 | THUMBNAILS_SIZE, | |
699 | VIDEO_CATEGORIES, | |
700 | VIDEO_LANGUAGES, | |
701 | VIDEO_PRIVACIES, | |
702 | VIDEO_LICENCES, | |
703 | VIDEO_STATES, | |
704 | VIDEO_RATE_TYPES, | |
705 | VIDEO_MIMETYPE_EXT, | |
706 | VIDEO_TRANSCODING_FPS, | |
707 | FFMPEG_NICE, | |
708 | VIDEO_ABUSE_STATES, | |
709 | JOB_REQUEST_TIMEOUT, | |
710 | USER_PASSWORD_RESET_LIFETIME, | |
711 | USER_EMAIL_VERIFY_LIFETIME, | |
712 | IMAGE_MIMETYPE_EXT, | |
713 | OVERVIEWS, | |
714 | SCHEDULER_INTERVALS_MS, | |
715 | REPEAT_JOBS, | |
716 | STATIC_DOWNLOAD_PATHS, | |
717 | RATES_LIMIT, | |
718 | VIDEO_EXT_MIMETYPE, | |
719 | CRAWL_REQUEST_CONCURRENCY, | |
720 | JOB_COMPLETED_LIFETIME, | |
721 | VIDEO_IMPORT_STATES, | |
722 | VIDEO_VIEW_LIFETIME, | |
723 | buildLanguages | |
724 | } | |
725 | ||
726 | // --------------------------------------------------------------------------- | |
727 | ||
728 | function getLocalConfigFilePath () { | |
729 | const configSources = config.util.getConfigSources() | |
730 | if (configSources.length === 0) throw new Error('Invalid config source.') | |
731 | ||
732 | let filename = 'local' | |
733 | if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}` | |
734 | if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}` | |
735 | ||
736 | return join(dirname(configSources[ 0 ].name), filename + '.json') | |
737 | } | |
738 | ||
739 | function updateWebserverConfig () { | |
740 | CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT) | |
741 | CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP) | |
742 | } | |
743 | ||
744 | function buildVideosRedundancy (objs: { strategy: VideoRedundancyStrategy, size: string }[]): VideosRedundancy[] { | |
745 | if (!objs) return [] | |
746 | ||
747 | return objs.map(obj => { | |
748 | return { | |
749 | strategy: obj.strategy, | |
750 | size: bytes.parse(obj.size) | |
751 | } | |
752 | }) | |
753 | } | |
754 | ||
755 | function buildLanguages () { | |
756 | const iso639 = require('iso-639-3') | |
757 | ||
758 | const languages: { [ id: string ]: string } = {} | |
759 | ||
760 | const additionalLanguages = { | |
761 | 'sgn': true, // Sign languages (macro language) | |
762 | 'ase': true, // American sign language | |
763 | 'sdl': true, // Arabian sign language | |
764 | 'bfi': true, // British sign language | |
765 | 'bzs': true, // Brazilian sign language | |
766 | 'csl': true, // Chinese sign language | |
767 | 'cse': true, // Czech sign language | |
768 | 'dsl': true, // Danish sign language | |
769 | 'fsl': true, // French sign language | |
770 | 'gsg': true, // German sign language | |
771 | 'pks': true, // Pakistan sign language | |
772 | 'jsl': true, // Japanese sign language | |
773 | 'sfs': true, // South African sign language | |
774 | 'swl': true, // Swedish sign language | |
775 | 'rsl': true, // Russian sign language: true | |
776 | ||
777 | 'epo': true, // Esperanto | |
778 | 'tlh': true, // Klingon | |
779 | 'jbo': true, // Lojban | |
780 | 'avk': true // Kotava | |
781 | } | |
782 | ||
783 | // Only add ISO639-1 languages and some sign languages (ISO639-3) | |
784 | iso639 | |
785 | .filter(l => { | |
786 | return (l.iso6391 !== null && l.type === 'living') || | |
787 | additionalLanguages[l.iso6393] === true | |
788 | }) | |
789 | .forEach(l => languages[l.iso6391 || l.iso6393] = l.name) | |
790 | ||
791 | // Override Occitan label | |
792 | languages['oc'] = 'Occitan' | |
793 | ||
794 | return languages | |
795 | } | |
796 | ||
797 | export function reloadConfig () { | |
798 | ||
799 | function directory () { | |
800 | if (process.env.NODE_CONFIG_DIR) { | |
801 | return process.env.NODE_CONFIG_DIR | |
802 | } | |
803 | ||
804 | return join(root(), 'config') | |
805 | } | |
806 | ||
807 | function purge () { | |
808 | for (const fileName in require.cache) { | |
809 | if (-1 === fileName.indexOf(directory())) { | |
810 | continue | |
811 | } | |
812 | ||
813 | delete require.cache[fileName] | |
814 | } | |
815 | ||
816 | delete require.cache[require.resolve('config')] | |
817 | } | |
818 | ||
819 | purge() | |
820 | ||
821 | config = require('config') | |
822 | ||
823 | updateWebserverConfig() | |
824 | } |