]> git.immae.eu Git - github/Chocobozzz/PeerTube.git/blame_incremental - server/initializers/constants.ts
Use a profile manager for transcoding
[github/Chocobozzz/PeerTube.git] / server / initializers / constants.ts
... / ...
CommitLineData
1import { randomInt } from '../../shared/core-utils/miscs/miscs'
2import { CronRepeatOptions, EveryRepeatOptions } from 'bull'
3import { randomBytes } from 'crypto'
4import { invert } from 'lodash'
5import { join } from 'path'
6import {
7 AbuseState,
8 JobType,
9 VideoImportState,
10 VideoPrivacy,
11 VideoRateType,
12 VideoResolution,
13 VideoState,
14 VideoTranscodingFPS
15} from '../../shared/models'
16import { ActivityPubActorType } from '../../shared/models/activitypub'
17import { FollowState } from '../../shared/models/actors'
18import { NSFWPolicyType } from '../../shared/models/videos/nsfw-policy.type'
19import { VideoPlaylistPrivacy } from '../../shared/models/videos/playlist/video-playlist-privacy.model'
20import { VideoPlaylistType } from '../../shared/models/videos/playlist/video-playlist-type.model'
21// Do not use barrels, remain constants as independent as possible
22import { isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
23import { CONFIG, registerConfigChangedHandler } from './config'
24
25// ---------------------------------------------------------------------------
26
27const LAST_MIGRATION_VERSION = 570
28
29// ---------------------------------------------------------------------------
30
31const API_VERSION = 'v1'
32const PEERTUBE_VERSION = require(join(root(), 'package.json')).version
33
34const PAGINATION = {
35 GLOBAL: {
36 COUNT: {
37 DEFAULT: 15,
38 MAX: 100
39 }
40 },
41 OUTBOX: {
42 COUNT: {
43 MAX: 50
44 }
45 }
46}
47
48const WEBSERVER = {
49 URL: '',
50 HOST: '',
51 SCHEME: '',
52 WS: '',
53 HOSTNAME: '',
54 PORT: 0,
55 RTMP_URL: ''
56}
57
58// Sortable columns per schema
59const SORTABLE_COLUMNS = {
60 USERS: [ 'id', 'username', 'videoQuotaUsed', 'createdAt', 'lastLoginDate', 'role' ],
61 USER_SUBSCRIPTIONS: [ 'id', 'createdAt' ],
62 ACCOUNTS: [ 'createdAt' ],
63 JOBS: [ 'createdAt' ],
64 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
65 VIDEO_IMPORTS: [ 'createdAt' ],
66
67 VIDEO_COMMENT_THREADS: [ 'createdAt', 'totalReplies' ],
68 VIDEO_COMMENTS: [ 'createdAt' ],
69
70 VIDEO_RATES: [ 'createdAt' ],
71 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
72 FOLLOWERS: [ 'createdAt', 'state', 'score' ],
73 FOLLOWING: [ 'createdAt', 'redundancyAllowed', 'state' ],
74
75 VIDEOS: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'trending', 'hot' ],
76
77 // Don't forget to update peertube-search-index with the same values
78 VIDEOS_SEARCH: [ 'name', 'duration', 'createdAt', 'publishedAt', 'originallyPublishedAt', 'views', 'likes', 'match' ],
79 VIDEO_CHANNELS_SEARCH: [ 'match', 'displayName', 'createdAt' ],
80
81 ABUSES: [ 'id', 'createdAt', 'state' ],
82
83 ACCOUNTS_BLOCKLIST: [ 'createdAt' ],
84 SERVERS_BLOCKLIST: [ 'createdAt' ],
85
86 USER_NOTIFICATIONS: [ 'createdAt', 'read' ],
87
88 VIDEO_PLAYLISTS: [ 'name', 'displayName', 'createdAt', 'updatedAt' ],
89
90 PLUGINS: [ 'name', 'createdAt', 'updatedAt' ],
91
92 AVAILABLE_PLUGINS: [ 'npmName', 'popularity' ],
93
94 VIDEO_REDUNDANCIES: [ 'name' ]
95}
96
97const OAUTH_LIFETIME = {
98 ACCESS_TOKEN: 3600 * 24, // 1 day, for upload
99 REFRESH_TOKEN: 1209600 // 2 weeks
100}
101
102const ROUTE_CACHE_LIFETIME = {
103 FEEDS: '15 minutes',
104 ROBOTS: '2 hours',
105 SITEMAP: '1 day',
106 SECURITYTXT: '2 hours',
107 NODEINFO: '10 minutes',
108 DNT_POLICY: '1 week',
109 ACTIVITY_PUB: {
110 VIDEOS: '1 second' // 1 second, cache concurrent requests after a broadcast for example
111 },
112 STATS: '4 hours'
113}
114
115// ---------------------------------------------------------------------------
116
117// Number of points we add/remove after a successful/bad request
118const ACTOR_FOLLOW_SCORE = {
119 PENALTY: -10,
120 BONUS: 10,
121 BASE: 1000,
122 MAX: 10000
123}
124
125const FOLLOW_STATES: { [ id: string ]: FollowState } = {
126 PENDING: 'pending',
127 ACCEPTED: 'accepted'
128}
129
130const REMOTE_SCHEME = {
131 HTTP: 'https',
132 WS: 'wss'
133}
134
135const JOB_ATTEMPTS: { [id in JobType]: number } = {
136 'activitypub-http-broadcast': 5,
137 'activitypub-http-unicast': 5,
138 'activitypub-http-fetcher': 5,
139 'activitypub-follow': 5,
140 'video-file-import': 1,
141 'video-transcoding': 1,
142 'video-import': 1,
143 'email': 5,
144 'videos-views': 1,
145 'activitypub-refresher': 1,
146 'video-redundancy': 1,
147 'video-live-ending': 1
148}
149const JOB_CONCURRENCY: { [id in JobType]: number } = {
150 'activitypub-http-broadcast': 1,
151 'activitypub-http-unicast': 5,
152 'activitypub-http-fetcher': 1,
153 'activitypub-follow': 1,
154 'video-file-import': 1,
155 'video-transcoding': 1,
156 'video-import': 1,
157 'email': 5,
158 'videos-views': 1,
159 'activitypub-refresher': 1,
160 'video-redundancy': 1,
161 'video-live-ending': 10
162}
163const JOB_TTL: { [id in JobType]: number } = {
164 'activitypub-http-broadcast': 60000 * 10, // 10 minutes
165 'activitypub-http-unicast': 60000 * 10, // 10 minutes
166 'activitypub-http-fetcher': 1000 * 3600 * 10, // 10 hours
167 'activitypub-follow': 60000 * 10, // 10 minutes
168 'video-file-import': 1000 * 3600, // 1 hour
169 'video-transcoding': 1000 * 3600 * 48, // 2 days, transcoding could be long
170 'video-import': 1000 * 3600 * 2, // 2 hours
171 'email': 60000 * 10, // 10 minutes
172 'videos-views': undefined, // Unlimited
173 'activitypub-refresher': 60000 * 10, // 10 minutes
174 'video-redundancy': 1000 * 3600 * 3, // 3 hours
175 'video-live-ending': 1000 * 60 * 10 // 10 minutes
176}
177const REPEAT_JOBS: { [ id: string ]: EveryRepeatOptions | CronRepeatOptions } = {
178 'videos-views': {
179 cron: randomInt(1, 20) + ' * * * *' // Between 1-20 minutes past the hour
180 }
181}
182const JOB_PRIORITY = {
183 TRANSCODING: {
184 OPTIMIZER: 10,
185 NEW_RESOLUTION: 100
186 }
187}
188
189const BROADCAST_CONCURRENCY = 10 // How many requests in parallel we do in activitypub-http-broadcast job
190const CRAWL_REQUEST_CONCURRENCY = 1 // How many requests in parallel to fetch remote data (likes, shares...)
191const JOB_REQUEST_TIMEOUT = 3000 // 3 seconds
192const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2 // 2 days
193const VIDEO_IMPORT_TIMEOUT = 1000 * 3600 // 1 hour
194
195const SCHEDULER_INTERVALS_MS = {
196 actorFollowScores: 60000 * 60, // 1 hour
197 removeOldJobs: 60000 * 60, // 1 hour
198 updateVideos: 60000, // 1 minute
199 youtubeDLUpdate: 60000 * 60 * 24, // 1 day
200 checkPlugins: CONFIG.PLUGINS.INDEX.CHECK_LATEST_VERSIONS_INTERVAL,
201 autoFollowIndexInstances: 60000 * 60 * 24, // 1 day
202 removeOldViews: 60000 * 60 * 24, // 1 day
203 removeOldHistory: 60000 * 60 * 24, // 1 day
204 updateInboxStats: 1000 * 60// 1 minute
205}
206
207// ---------------------------------------------------------------------------
208
209const CONSTRAINTS_FIELDS = {
210 USERS: {
211 NAME: { min: 1, max: 120 }, // Length
212 DESCRIPTION: { min: 3, max: 1000 }, // Length
213 USERNAME: { min: 1, max: 50 }, // Length
214 PASSWORD: { min: 6, max: 255 }, // Length
215 VIDEO_QUOTA: { min: -1 },
216 VIDEO_QUOTA_DAILY: { min: -1 },
217 VIDEO_LANGUAGES: { max: 500 }, // Array length
218 BLOCKED_REASON: { min: 3, max: 250 } // Length
219 },
220 ABUSES: {
221 REASON: { min: 2, max: 3000 }, // Length
222 MODERATION_COMMENT: { min: 2, max: 3000 } // Length
223 },
224 ABUSE_MESSAGES: {
225 MESSAGE: { min: 2, max: 3000 } // Length
226 },
227 VIDEO_BLACKLIST: {
228 REASON: { min: 2, max: 300 } // Length
229 },
230 VIDEO_CHANNELS: {
231 NAME: { min: 1, max: 120 }, // Length
232 DESCRIPTION: { min: 3, max: 1000 }, // Length
233 SUPPORT: { min: 3, max: 1000 }, // Length
234 URL: { min: 3, max: 2000 } // Length
235 },
236 VIDEO_CAPTIONS: {
237 CAPTION_FILE: {
238 EXTNAME: [ '.vtt', '.srt' ],
239 FILE_SIZE: {
240 max: 2 * 1024 * 1024 // 2MB
241 }
242 }
243 },
244 VIDEO_IMPORTS: {
245 URL: { min: 3, max: 2000 }, // Length
246 TORRENT_NAME: { min: 3, max: 255 }, // Length
247 TORRENT_FILE: {
248 EXTNAME: [ '.torrent' ],
249 FILE_SIZE: {
250 max: 1024 * 200 // 200 KB
251 }
252 }
253 },
254 VIDEOS_REDUNDANCY: {
255 URL: { min: 3, max: 2000 } // Length
256 },
257 VIDEO_RATES: {
258 URL: { min: 3, max: 2000 } // Length
259 },
260 VIDEOS: {
261 NAME: { min: 3, max: 120 }, // Length
262 LANGUAGE: { min: 1, max: 10 }, // Length
263 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
264 DESCRIPTION: { min: 3, max: 10000 }, // Length
265 SUPPORT: { min: 3, max: 1000 }, // Length
266 IMAGE: {
267 EXTNAME: [ '.png', '.jpg', '.jpeg', '.webp' ],
268 FILE_SIZE: {
269 max: 2 * 1024 * 1024 // 2MB
270 }
271 },
272 EXTNAME: [] as string[],
273 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
274 DURATION: { min: 0 }, // Number
275 TAGS: { min: 0, max: 5 }, // Number of total tags
276 TAG: { min: 2, max: 30 }, // Length
277 VIEWS: { min: 0 },
278 LIKES: { min: 0 },
279 DISLIKES: { min: 0 },
280 FILE_SIZE: { min: -1 },
281 URL: { min: 3, max: 2000 } // Length
282 },
283 VIDEO_PLAYLISTS: {
284 NAME: { min: 1, max: 120 }, // Length
285 DESCRIPTION: { min: 3, max: 1000 }, // Length
286 URL: { min: 3, max: 2000 }, // Length
287 IMAGE: {
288 EXTNAME: [ '.jpg', '.jpeg' ],
289 FILE_SIZE: {
290 max: 2 * 1024 * 1024 // 2MB
291 }
292 }
293 },
294 ACTORS: {
295 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
296 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
297 URL: { min: 3, max: 2000 }, // Length
298 AVATAR: {
299 EXTNAME: [ '.png', '.jpeg', '.jpg', '.gif', '.webp' ],
300 FILE_SIZE: {
301 max: 2 * 1024 * 1024 // 2MB
302 }
303 }
304 },
305 VIDEO_EVENTS: {
306 COUNT: { min: 0 }
307 },
308 VIDEO_COMMENTS: {
309 TEXT: { min: 1, max: 10000 }, // Length
310 URL: { min: 3, max: 2000 } // Length
311 },
312 VIDEO_SHARE: {
313 URL: { min: 3, max: 2000 } // Length
314 },
315 CONTACT_FORM: {
316 FROM_NAME: { min: 1, max: 120 }, // Length
317 BODY: { min: 3, max: 5000 } // Length
318 },
319 PLUGINS: {
320 NAME: { min: 1, max: 214 }, // Length
321 DESCRIPTION: { min: 1, max: 20000 } // Length
322 },
323 COMMONS: {
324 URL: { min: 5, max: 2000 } // Length
325 }
326}
327
328const VIEW_LIFETIME = {
329 VIDEO: 60000 * 60, // 1 hour
330 LIVE: 60000 * 5 // 5 minutes
331}
332
333let CONTACT_FORM_LIFETIME = 60000 * 60 // 1 hour
334
335const VIDEO_TRANSCODING_FPS: VideoTranscodingFPS = {
336 MIN: 10,
337 STANDARD: [ 24, 25, 30 ],
338 HD_STANDARD: [ 50, 60 ],
339 AVERAGE: 30,
340 MAX: 60,
341 KEEP_ORIGIN_FPS_RESOLUTION_MIN: 720 // We keep the original FPS on high resolutions (720 minimum)
342}
343
344const DEFAULT_AUDIO_RESOLUTION = VideoResolution.H_480P
345
346const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
347 LIKE: 'like',
348 DISLIKE: 'dislike'
349}
350
351const FFMPEG_NICE: { [ id: string ]: number } = {
352 // parent process defaults to niceness = 0
353 // reminder: lower = higher priority, max value is 19, lowest is -20
354 LIVE: 5, // prioritize over VOD and THUMBNAIL
355 THUMBNAIL: 10,
356 VOD: 15
357}
358
359const VIDEO_CATEGORIES = {
360 1: 'Music',
361 2: 'Films',
362 3: 'Vehicles',
363 4: 'Art',
364 5: 'Sports',
365 6: 'Travels',
366 7: 'Gaming',
367 8: 'People',
368 9: 'Comedy',
369 10: 'Entertainment',
370 11: 'News & Politics',
371 12: 'How To',
372 13: 'Education',
373 14: 'Activism',
374 15: 'Science & Technology',
375 16: 'Animals',
376 17: 'Kids',
377 18: 'Food'
378}
379
380// See https://creativecommons.org/licenses/?lang=en
381const VIDEO_LICENCES = {
382 1: 'Attribution',
383 2: 'Attribution - Share Alike',
384 3: 'Attribution - No Derivatives',
385 4: 'Attribution - Non Commercial',
386 5: 'Attribution - Non Commercial - Share Alike',
387 6: 'Attribution - Non Commercial - No Derivatives',
388 7: 'Public Domain Dedication'
389}
390
391const VIDEO_LANGUAGES: { [id: string]: string } = {}
392
393const VIDEO_PRIVACIES: { [ id in VideoPrivacy ]: string } = {
394 [VideoPrivacy.PUBLIC]: 'Public',
395 [VideoPrivacy.UNLISTED]: 'Unlisted',
396 [VideoPrivacy.PRIVATE]: 'Private',
397 [VideoPrivacy.INTERNAL]: 'Internal'
398}
399
400const VIDEO_STATES: { [ id in VideoState ]: string } = {
401 [VideoState.PUBLISHED]: 'Published',
402 [VideoState.TO_TRANSCODE]: 'To transcode',
403 [VideoState.TO_IMPORT]: 'To import',
404 [VideoState.WAITING_FOR_LIVE]: 'Waiting for livestream',
405 [VideoState.LIVE_ENDED]: 'Livestream ended'
406}
407
408const VIDEO_IMPORT_STATES: { [ id in VideoImportState ]: string } = {
409 [VideoImportState.FAILED]: 'Failed',
410 [VideoImportState.PENDING]: 'Pending',
411 [VideoImportState.SUCCESS]: 'Success',
412 [VideoImportState.REJECTED]: 'Rejected'
413}
414
415const ABUSE_STATES: { [ id in AbuseState ]: string } = {
416 [AbuseState.PENDING]: 'Pending',
417 [AbuseState.REJECTED]: 'Rejected',
418 [AbuseState.ACCEPTED]: 'Accepted'
419}
420
421const VIDEO_PLAYLIST_PRIVACIES: { [ id in VideoPlaylistPrivacy ]: string } = {
422 [VideoPlaylistPrivacy.PUBLIC]: 'Public',
423 [VideoPlaylistPrivacy.UNLISTED]: 'Unlisted',
424 [VideoPlaylistPrivacy.PRIVATE]: 'Private'
425}
426
427const VIDEO_PLAYLIST_TYPES: { [ id in VideoPlaylistType ]: string } = {
428 [VideoPlaylistType.REGULAR]: 'Regular',
429 [VideoPlaylistType.WATCH_LATER]: 'Watch later'
430}
431
432const MIMETYPES = {
433 AUDIO: {
434 MIMETYPE_EXT: {
435 'audio/mpeg': '.mp3',
436 'audio/mp3': '.mp3',
437 'application/ogg': '.ogg',
438 'audio/ogg': '.ogg',
439 'audio/x-ms-wma': '.wma',
440 'audio/wav': '.wav',
441 'audio/x-flac': '.flac',
442 'audio/flac': '.flac',
443 '‎audio/aac': '.aac',
444 'audio/ac3': '.ac3'
445 },
446 EXT_MIMETYPE: null as { [ id: string ]: string }
447 },
448 VIDEO: {
449 MIMETYPE_EXT: null as { [ id: string ]: string | string[] },
450 MIMETYPES_REGEX: null as string,
451 EXT_MIMETYPE: null as { [ id: string ]: string }
452 },
453 IMAGE: {
454 MIMETYPE_EXT: {
455 'image/png': '.png',
456 'image/jpg': '.jpg',
457 'image/jpeg': '.jpg'
458 },
459 EXT_MIMETYPE: null as { [ id: string ]: string }
460 },
461 VIDEO_CAPTIONS: {
462 MIMETYPE_EXT: {
463 'text/vtt': '.vtt',
464 'application/x-subrip': '.srt',
465 'text/plain': '.srt'
466 }
467 },
468 TORRENT: {
469 MIMETYPE_EXT: {
470 'application/x-bittorrent': '.torrent'
471 }
472 }
473}
474MIMETYPES.AUDIO.EXT_MIMETYPE = invert(MIMETYPES.AUDIO.MIMETYPE_EXT)
475MIMETYPES.IMAGE.EXT_MIMETYPE = invert(MIMETYPES.IMAGE.MIMETYPE_EXT)
476
477// ---------------------------------------------------------------------------
478
479const OVERVIEWS = {
480 VIDEOS: {
481 SAMPLE_THRESHOLD: 6,
482 SAMPLES_COUNT: 20
483 }
484}
485
486const VIDEO_CHANNELS = {
487 MAX_PER_USER: 20
488}
489
490// ---------------------------------------------------------------------------
491
492const SERVER_ACTOR_NAME = 'peertube'
493
494const ACTIVITY_PUB = {
495 POTENTIAL_ACCEPT_HEADERS: [
496 'application/activity+json',
497 'application/ld+json',
498 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
499 ],
500 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
501 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
502 COLLECTION_ITEMS_PER_PAGE: 10,
503 FETCH_PAGE_LIMIT: 2000,
504 URL_MIME_TYPES: {
505 VIDEO: [] as string[],
506 TORRENT: [ 'application/x-bittorrent' ],
507 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
508 },
509 MAX_RECURSION_COMMENTS: 100,
510 ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
511 VIDEO_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2, // 2 days
512 VIDEO_PLAYLIST_REFRESH_INTERVAL: 3600 * 24 * 1000 * 2 // 2 days
513}
514
515const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
516 GROUP: 'Group',
517 PERSON: 'Person',
518 APPLICATION: 'Application',
519 ORGANIZATION: 'Organization',
520 SERVICE: 'Service'
521}
522
523const HTTP_SIGNATURE = {
524 HEADER_NAME: 'signature',
525 ALGORITHM: 'rsa-sha256',
526 HEADERS_TO_SIGN: [ '(request-target)', 'host', 'date', 'digest' ],
527 REQUIRED_HEADERS: {
528 ALL: [ '(request-target)', 'host', 'date' ],
529 POST: [ '(request-target)', 'host', 'date', 'digest' ]
530 },
531 CLOCK_SKEW_SECONDS: 1800
532}
533
534// ---------------------------------------------------------------------------
535
536let PRIVATE_RSA_KEY_SIZE = 2048
537
538// Password encryption
539const BCRYPT_SALT_SIZE = 10
540
541const USER_PASSWORD_RESET_LIFETIME = 60000 * 60 // 60 minutes
542const USER_PASSWORD_CREATE_LIFETIME = 60000 * 60 * 24 * 7 // 7 days
543
544const USER_EMAIL_VERIFY_LIFETIME = 60000 * 60 // 60 minutes
545
546const NSFW_POLICY_TYPES: { [ id: string ]: NSFWPolicyType } = {
547 DO_NOT_LIST: 'do_not_list',
548 BLUR: 'blur',
549 DISPLAY: 'display'
550}
551
552// ---------------------------------------------------------------------------
553
554// Express static paths (router)
555const STATIC_PATHS = {
556 PREVIEWS: '/static/previews/',
557 THUMBNAILS: '/static/thumbnails/',
558 TORRENTS: '/static/torrents/',
559 WEBSEED: '/static/webseed/',
560 REDUNDANCY: '/static/redundancy/',
561 STREAMING_PLAYLISTS: {
562 HLS: '/static/streaming-playlists/hls'
563 },
564 AVATARS: '/static/avatars/',
565 VIDEO_CAPTIONS: '/static/video-captions/'
566}
567const STATIC_DOWNLOAD_PATHS = {
568 TORRENTS: '/download/torrents/',
569 VIDEOS: '/download/videos/',
570 HLS_VIDEOS: '/download/streaming-playlists/hls/videos/'
571}
572const LAZY_STATIC_PATHS = {
573 AVATARS: '/lazy-static/avatars/',
574 PREVIEWS: '/lazy-static/previews/',
575 VIDEO_CAPTIONS: '/lazy-static/video-captions/'
576}
577
578// Cache control
579const STATIC_MAX_AGE = {
580 SERVER: '2h',
581 CLIENT: '30d'
582}
583
584// Videos thumbnail size
585const THUMBNAILS_SIZE = {
586 width: 223,
587 height: 122,
588 minWidth: 150
589}
590const PREVIEWS_SIZE = {
591 width: 850,
592 height: 480,
593 minWidth: 400
594}
595const AVATARS_SIZE = {
596 width: 120,
597 height: 120
598}
599
600const EMBED_SIZE = {
601 width: 560,
602 height: 315
603}
604
605// Sub folders of cache directory
606const FILES_CACHE = {
607 PREVIEWS: {
608 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'previews'),
609 MAX_AGE: 1000 * 3600 * 3 // 3 hours
610 },
611 VIDEO_CAPTIONS: {
612 DIRECTORY: join(CONFIG.STORAGE.CACHE_DIR, 'video-captions'),
613 MAX_AGE: 1000 * 3600 * 3 // 3 hours
614 }
615}
616
617const LRU_CACHE = {
618 USER_TOKENS: {
619 MAX_SIZE: 1000
620 },
621 AVATAR_STATIC: {
622 MAX_SIZE: 500
623 }
624}
625
626const HLS_STREAMING_PLAYLIST_DIRECTORY = join(CONFIG.STORAGE.STREAMING_PLAYLISTS_DIR, 'hls')
627const HLS_REDUNDANCY_DIRECTORY = join(CONFIG.STORAGE.REDUNDANCY_DIR, 'hls')
628
629const VIDEO_LIVE = {
630 EXTENSION: '.ts',
631 CLEANUP_DELAY: 1000 * 60 * 5, // 5 minutes
632 SEGMENT_TIME_SECONDS: 4, // 4 seconds
633 SEGMENTS_LIST_SIZE: 15, // 15 maximum segments in live playlist
634 REPLAY_DIRECTORY: 'replay',
635 EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION: 4,
636 MAX_SOCKET_WAITING_DATA: 1024 * 1000 * 100, // 100MB
637 RTMP: {
638 CHUNK_SIZE: 60000,
639 GOP_CACHE: true,
640 PING: 60,
641 PING_TIMEOUT: 30,
642 BASE_PATH: 'live'
643 }
644}
645
646const MEMOIZE_TTL = {
647 OVERVIEWS_SAMPLE: 1000 * 3600 * 4, // 4 hours
648 INFO_HASH_EXISTS: 1000 * 3600 * 12, // 12 hours
649 LIVE_ABLE_TO_UPLOAD: 1000 * 60, // 1 minute
650 LIVE_CHECK_SOCKET_HEALTH: 1000 * 60 // 1 minute
651}
652
653const MEMOIZE_LENGTH = {
654 INFO_HASH_EXISTS: 200
655}
656
657const QUEUE_CONCURRENCY = {
658 AVATAR_PROCESS_IMAGE: 3
659}
660
661const REDUNDANCY = {
662 VIDEOS: {
663 RANDOMIZED_FACTOR: 5
664 }
665}
666
667const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
668
669const ASSETS_PATH = {
670 DEFAULT_AUDIO_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-audio-background.jpg'),
671 DEFAULT_LIVE_BACKGROUND: join(root(), 'dist', 'server', 'assets', 'default-live-background.jpg')
672}
673
674// ---------------------------------------------------------------------------
675
676const CUSTOM_HTML_TAG_COMMENTS = {
677 TITLE: '<!-- title tag -->',
678 DESCRIPTION: '<!-- description tag -->',
679 CUSTOM_CSS: '<!-- custom css tag -->',
680 META_TAGS: '<!-- meta tags -->'
681}
682
683// ---------------------------------------------------------------------------
684
685const FEEDS = {
686 COUNT: 20
687}
688
689const MAX_LOGS_OUTPUT_CHARACTERS = 10 * 1000 * 1000
690const LOG_FILENAME = 'peertube.log'
691const AUDIT_LOG_FILENAME = 'peertube-audit.log'
692
693// ---------------------------------------------------------------------------
694
695const TRACKER_RATE_LIMITS = {
696 INTERVAL: 60000 * 5, // 5 minutes
697 ANNOUNCES_PER_IP_PER_INFOHASH: 15, // maximum announces per torrent in the interval
698 ANNOUNCES_PER_IP: 30, // maximum announces for all our torrents in the interval
699 BLOCK_IP_LIFETIME: 60000 * 3 // 3 minutes
700}
701
702const P2P_MEDIA_LOADER_PEER_VERSION = 2
703
704// ---------------------------------------------------------------------------
705
706const PLUGIN_GLOBAL_CSS_FILE_NAME = 'plugins-global.css'
707const PLUGIN_GLOBAL_CSS_PATH = join(CONFIG.STORAGE.TMP_DIR, PLUGIN_GLOBAL_CSS_FILE_NAME)
708
709let PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 1000 * 60 * 5 // 5 minutes
710
711const DEFAULT_THEME_NAME = 'default'
712const DEFAULT_USER_THEME_NAME = 'instance-default'
713
714// ---------------------------------------------------------------------------
715
716const SEARCH_INDEX = {
717 ROUTES: {
718 VIDEOS: '/api/v1/search/videos',
719 VIDEO_CHANNELS: '/api/v1/search/video-channels'
720 }
721}
722
723// ---------------------------------------------------------------------------
724
725// Special constants for a test instance
726if (isTestInstance() === true) {
727 PRIVATE_RSA_KEY_SIZE = 1024
728
729 ACTOR_FOLLOW_SCORE.BASE = 20
730
731 REMOTE_SCHEME.HTTP = 'http'
732 REMOTE_SCHEME.WS = 'ws'
733
734 STATIC_MAX_AGE.SERVER = '0'
735
736 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
737 ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
738 ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
739 ACTIVITY_PUB.VIDEO_PLAYLIST_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
740
741 CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
742 CONSTRAINTS_FIELDS.VIDEOS.IMAGE.FILE_SIZE.max = 400 * 1024 // 400KB
743
744 SCHEDULER_INTERVALS_MS.actorFollowScores = 1000
745 SCHEDULER_INTERVALS_MS.removeOldJobs = 10000
746 SCHEDULER_INTERVALS_MS.removeOldHistory = 5000
747 SCHEDULER_INTERVALS_MS.removeOldViews = 5000
748 SCHEDULER_INTERVALS_MS.updateVideos = 5000
749 SCHEDULER_INTERVALS_MS.autoFollowIndexInstances = 5000
750 SCHEDULER_INTERVALS_MS.updateInboxStats = 5000
751 REPEAT_JOBS['videos-views'] = { every: 5000 }
752
753 REDUNDANCY.VIDEOS.RANDOMIZED_FACTOR = 1
754
755 VIEW_LIFETIME.VIDEO = 1000 // 1 second
756 VIEW_LIFETIME.LIVE = 1000 * 5 // 5 second
757 CONTACT_FORM_LIFETIME = 1000 // 1 second
758
759 JOB_ATTEMPTS['email'] = 1
760
761 FILES_CACHE.VIDEO_CAPTIONS.MAX_AGE = 3000
762 MEMOIZE_TTL.OVERVIEWS_SAMPLE = 3000
763 MEMOIZE_TTL.LIVE_ABLE_TO_UPLOAD = 3000
764 OVERVIEWS.VIDEOS.SAMPLE_THRESHOLD = 2
765
766 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME = 5000
767
768 VIDEO_LIVE.CLEANUP_DELAY = 5000
769 VIDEO_LIVE.SEGMENT_TIME_SECONDS = 2
770 VIDEO_LIVE.EDGE_LIVE_DELAY_SEGMENTS_NOTIFICATION = 1
771}
772
773updateWebserverUrls()
774updateWebserverConfig()
775
776registerConfigChangedHandler(() => {
777 updateWebserverUrls()
778 updateWebserverConfig()
779})
780
781// ---------------------------------------------------------------------------
782
783const FILES_CONTENT_HASH = {
784 MANIFEST: generateContentHash(),
785 FAVICON: generateContentHash(),
786 LOGO: generateContentHash()
787}
788
789// ---------------------------------------------------------------------------
790
791export {
792 WEBSERVER,
793 API_VERSION,
794 VIDEO_LIVE,
795 PEERTUBE_VERSION,
796 LAZY_STATIC_PATHS,
797 SEARCH_INDEX,
798 HLS_REDUNDANCY_DIRECTORY,
799 P2P_MEDIA_LOADER_PEER_VERSION,
800 AVATARS_SIZE,
801 ACCEPT_HEADERS,
802 BCRYPT_SALT_SIZE,
803 TRACKER_RATE_LIMITS,
804 FILES_CACHE,
805 LOG_FILENAME,
806 CONSTRAINTS_FIELDS,
807 EMBED_SIZE,
808 REDUNDANCY,
809 JOB_CONCURRENCY,
810 JOB_ATTEMPTS,
811 LAST_MIGRATION_VERSION,
812 OAUTH_LIFETIME,
813 CUSTOM_HTML_TAG_COMMENTS,
814 BROADCAST_CONCURRENCY,
815 AUDIT_LOG_FILENAME,
816 PAGINATION,
817 ACTOR_FOLLOW_SCORE,
818 PREVIEWS_SIZE,
819 REMOTE_SCHEME,
820 FOLLOW_STATES,
821 DEFAULT_USER_THEME_NAME,
822 SERVER_ACTOR_NAME,
823 PLUGIN_GLOBAL_CSS_FILE_NAME,
824 PLUGIN_GLOBAL_CSS_PATH,
825 PRIVATE_RSA_KEY_SIZE,
826 ROUTE_CACHE_LIFETIME,
827 SORTABLE_COLUMNS,
828 HLS_STREAMING_PLAYLIST_DIRECTORY,
829 FEEDS,
830 JOB_TTL,
831 DEFAULT_THEME_NAME,
832 NSFW_POLICY_TYPES,
833 STATIC_MAX_AGE,
834 STATIC_PATHS,
835 VIDEO_IMPORT_TIMEOUT,
836 VIDEO_PLAYLIST_TYPES,
837 MAX_LOGS_OUTPUT_CHARACTERS,
838 ACTIVITY_PUB,
839 ACTIVITY_PUB_ACTOR_TYPES,
840 THUMBNAILS_SIZE,
841 VIDEO_CATEGORIES,
842 MEMOIZE_LENGTH,
843 VIDEO_LANGUAGES,
844 VIDEO_PRIVACIES,
845 VIDEO_LICENCES,
846 VIDEO_STATES,
847 QUEUE_CONCURRENCY,
848 VIDEO_RATE_TYPES,
849 JOB_PRIORITY,
850 VIDEO_TRANSCODING_FPS,
851 FFMPEG_NICE,
852 ABUSE_STATES,
853 VIDEO_CHANNELS,
854 LRU_CACHE,
855 JOB_REQUEST_TIMEOUT,
856 USER_PASSWORD_RESET_LIFETIME,
857 USER_PASSWORD_CREATE_LIFETIME,
858 MEMOIZE_TTL,
859 USER_EMAIL_VERIFY_LIFETIME,
860 OVERVIEWS,
861 SCHEDULER_INTERVALS_MS,
862 REPEAT_JOBS,
863 STATIC_DOWNLOAD_PATHS,
864 MIMETYPES,
865 CRAWL_REQUEST_CONCURRENCY,
866 DEFAULT_AUDIO_RESOLUTION,
867 JOB_COMPLETED_LIFETIME,
868 HTTP_SIGNATURE,
869 VIDEO_IMPORT_STATES,
870 VIEW_LIFETIME,
871 CONTACT_FORM_LIFETIME,
872 VIDEO_PLAYLIST_PRIVACIES,
873 PLUGIN_EXTERNAL_AUTH_TOKEN_LIFETIME,
874 ASSETS_PATH,
875 FILES_CONTENT_HASH,
876 loadLanguages,
877 buildLanguages,
878 generateContentHash
879}
880
881// ---------------------------------------------------------------------------
882
883function buildVideoMimetypeExt () {
884 const data = {
885 // streamable formats that warrant cross-browser compatibility
886 'video/webm': '.webm',
887 // We'll add .ogg if additional extensions are enabled
888 // We could add .ogg here but since it could be an audio file,
889 // it would be confusing for users because PeerTube will refuse their file (based on the mimetype)
890 'video/ogg': [ '.ogv' ],
891 'video/mp4': '.mp4'
892 }
893
894 if (CONFIG.TRANSCODING.ENABLED) {
895 if (CONFIG.TRANSCODING.ALLOW_ADDITIONAL_EXTENSIONS) {
896 data['video/ogg'].push('.ogg')
897
898 Object.assign(data, {
899 'video/x-matroska': '.mkv',
900
901 // Developed by Apple
902 'video/quicktime': [ '.mov', '.qt', '.mqv' ], // often used as output format by editing software
903 'video/x-m4v': '.m4v',
904 'video/m4v': '.m4v',
905
906 // Developed by the Adobe Flash Platform
907 'video/x-flv': '.flv',
908 'video/x-f4v': '.f4v', // replacement for flv
909
910 // Developed by Microsoft
911 'video/x-ms-wmv': '.wmv',
912 'video/x-msvideo': '.avi',
913 'video/avi': '.avi',
914
915 // Developed by 3GPP
916 // common video formats for cell phones
917 'video/3gpp': [ '.3gp', '.3gpp' ],
918 'video/3gpp2': [ '.3g2', '.3gpp2' ],
919
920 // Developed by FFmpeg/Mplayer
921 'application/x-nut': '.nut',
922
923 // The standard video format used by many Sony and Panasonic HD camcorders.
924 // It is also used for storing high definition video on Blu-ray discs.
925 'video/mp2t': '.mts',
926 'video/m2ts': '.m2ts',
927
928 // Old formats reliant on MPEG-1/MPEG-2
929 'video/mpv': '.mpv',
930 'video/mpeg2': '.m2v',
931 'video/mpeg': [ '.m1v', '.mpg', '.mpe', '.mpeg', '.vob' ],
932 'video/dvd': '.vob',
933
934 // Could be anything
935 'application/octet-stream': null,
936 'application/mxf': '.mxf' // often used as exchange format by editing software
937 })
938 }
939
940 if (CONFIG.TRANSCODING.ALLOW_AUDIO_FILES) {
941 Object.assign(data, MIMETYPES.AUDIO.MIMETYPE_EXT)
942 }
943 }
944
945 return data
946}
947
948function updateWebserverUrls () {
949 WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
950 WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
951 WEBSERVER.WS = CONFIG.WEBSERVER.WS
952
953 WEBSERVER.SCHEME = CONFIG.WEBSERVER.SCHEME
954 WEBSERVER.HOSTNAME = CONFIG.WEBSERVER.HOSTNAME
955 WEBSERVER.PORT = CONFIG.WEBSERVER.PORT
956
957 WEBSERVER.RTMP_URL = 'rtmp://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.LIVE.RTMP.PORT + '/' + VIDEO_LIVE.RTMP.BASE_PATH
958}
959
960function updateWebserverConfig () {
961 MIMETYPES.VIDEO.MIMETYPE_EXT = buildVideoMimetypeExt()
962 MIMETYPES.VIDEO.MIMETYPES_REGEX = buildMimetypesRegex(MIMETYPES.VIDEO.MIMETYPE_EXT)
963
964 ACTIVITY_PUB.URL_MIME_TYPES.VIDEO = Object.keys(MIMETYPES.VIDEO.MIMETYPE_EXT)
965
966 MIMETYPES.VIDEO.EXT_MIMETYPE = buildVideoExtMimetype(MIMETYPES.VIDEO.MIMETYPE_EXT)
967
968 CONSTRAINTS_FIELDS.VIDEOS.EXTNAME = Object.keys(MIMETYPES.VIDEO.EXT_MIMETYPE)
969}
970
971function buildVideoExtMimetype (obj: { [ id: string ]: string | string[] }) {
972 const result: { [id: string]: string } = {}
973
974 for (const mimetype of Object.keys(obj)) {
975 const value = obj[mimetype]
976 if (!value) continue
977
978 const extensions = Array.isArray(value) ? value : [ value ]
979
980 for (const extension of extensions) {
981 result[extension] = mimetype
982 }
983 }
984
985 return result
986}
987
988function buildMimetypesRegex (obj: { [id: string]: string | string[] }) {
989 return Object.keys(obj)
990 .map(m => `(${m})`)
991 .join('|')
992}
993
994function loadLanguages () {
995 Object.assign(VIDEO_LANGUAGES, buildLanguages())
996}
997
998function buildLanguages () {
999 const iso639 = require('iso-639-3')
1000
1001 const languages: { [id: string]: string } = {}
1002
1003 const additionalLanguages = {
1004 sgn: true, // Sign languages (macro language)
1005 ase: true, // American sign language
1006 sdl: true, // Arabian sign language
1007 bfi: true, // British sign language
1008 bzs: true, // Brazilian sign language
1009 csl: true, // Chinese sign language
1010 cse: true, // Czech sign language
1011 dsl: true, // Danish sign language
1012 fsl: true, // French sign language
1013 gsg: true, // German sign language
1014 pks: true, // Pakistan sign language
1015 jsl: true, // Japanese sign language
1016 sfs: true, // South African sign language
1017 swl: true, // Swedish sign language
1018 rsl: true, // Russian sign language
1019
1020 kab: true, // Kabyle
1021
1022 epo: true, // Esperanto
1023 tlh: true, // Klingon
1024 jbo: true, // Lojban
1025 avk: true // Kotava
1026 }
1027
1028 // Only add ISO639-1 languages and some sign languages (ISO639-3)
1029 iso639
1030 .filter(l => {
1031 return (l.iso6391 !== undefined && l.type === 'living') ||
1032 additionalLanguages[l.iso6393] === true
1033 })
1034 .forEach(l => { languages[l.iso6391 || l.iso6393] = l.name })
1035
1036 // Override Occitan label
1037 languages['oc'] = 'Occitan'
1038 languages['el'] = 'Greek'
1039
1040 return languages
1041}
1042
1043function generateContentHash () {
1044 return randomBytes(20).toString('hex')
1045}