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