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