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