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